mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-11-22 00:05:58 -05:00
Update generated code for v1774 and 2025-05-28.preview
This commit is contained in:
parent
9e7bb8b824
commit
ff0097debd
1
API_VERSION
Normal file
1
API_VERSION
Normal file
@ -0,0 +1 @@
|
||||
2025-05-28.preview
|
||||
@ -1 +1 @@
|
||||
v1773
|
||||
v1774
|
||||
@ -4325,7 +4325,7 @@ module Stripe
|
||||
attr_accessor :ownership_exemption_reason
|
||||
# The company's phone number (used for verification).
|
||||
attr_accessor :phone
|
||||
# Attribute for param field registration_date
|
||||
# When the business was incorporated or registered.
|
||||
attr_accessor :registration_date
|
||||
# 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).
|
||||
attr_accessor :registration_number
|
||||
|
||||
@ -82,7 +82,7 @@ module Stripe
|
||||
# [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
|
||||
attr_reader :quantity
|
||||
end
|
||||
# The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
|
||||
# The coupon or promotion code to apply to this subscription update.
|
||||
attr_reader :discounts
|
||||
# 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.
|
||||
attr_reader :items
|
||||
@ -202,7 +202,7 @@ module Stripe
|
||||
@quantity = quantity
|
||||
end
|
||||
end
|
||||
# The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
|
||||
# The coupon or promotion code to apply to this subscription update.
|
||||
attr_accessor :discounts
|
||||
# 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.
|
||||
attr_accessor :items
|
||||
|
||||
@ -3263,7 +3263,7 @@ module Stripe
|
||||
attr_accessor :expires_at
|
||||
# Generate a post-purchase Invoice for one-time payments.
|
||||
attr_accessor :invoice_creation
|
||||
# A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
|
||||
# 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.
|
||||
#
|
||||
|
||||
@ -50,6 +50,13 @@ module Stripe
|
||||
|
||||
class IdNumber < Stripe::StripeObject; end
|
||||
|
||||
class Matching < Stripe::StripeObject
|
||||
# Strictness of the DOB matching policy to apply.
|
||||
attr_reader :dob
|
||||
# Strictness of the name matching policy to apply.
|
||||
attr_reader :name
|
||||
end
|
||||
|
||||
class Phone < Stripe::StripeObject
|
||||
# Request one time password verification of `provided_details.phone`.
|
||||
attr_reader :require_verification
|
||||
@ -60,6 +67,8 @@ module Stripe
|
||||
attr_reader :email
|
||||
# Attribute for field id_number
|
||||
attr_reader :id_number
|
||||
# Attribute for field matching
|
||||
attr_reader :matching
|
||||
# Attribute for field phone
|
||||
attr_reader :phone
|
||||
end
|
||||
@ -76,6 +85,13 @@ module Stripe
|
||||
attr_reader :status
|
||||
end
|
||||
|
||||
class RelatedPerson < Stripe::StripeObject
|
||||
# Token referencing the associated Account of the related Person resource.
|
||||
attr_reader :account
|
||||
# Token referencing the related Person resource.
|
||||
attr_reader :person
|
||||
end
|
||||
|
||||
class VerifiedOutputs < Stripe::StripeObject
|
||||
class Address < Stripe::StripeObject
|
||||
# City, district, suburb, town, or village.
|
||||
@ -227,6 +243,18 @@ module Stripe
|
||||
@phone = phone
|
||||
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.
|
||||
attr_accessor :account
|
||||
# A token referencing a Person resource that this verification is being used to verify.
|
||||
attr_accessor :person
|
||||
|
||||
def initialize(account: nil, person: nil)
|
||||
@account = account
|
||||
@person = person
|
||||
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.
|
||||
attr_accessor :client_reference_id
|
||||
# Specifies which fields in the response should be expanded.
|
||||
@ -241,6 +269,8 @@ module Stripe
|
||||
attr_accessor :related_customer
|
||||
# Token referencing a Customer Account resource.
|
||||
attr_accessor :related_customer_account
|
||||
# Tokens referencing a Person resource and it's associated account.
|
||||
attr_accessor :related_person
|
||||
# The URL that the user will be redirected to upon completing the verification flow.
|
||||
attr_accessor :return_url
|
||||
# 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`.
|
||||
@ -256,6 +286,7 @@ module Stripe
|
||||
provided_details: nil,
|
||||
related_customer: nil,
|
||||
related_customer_account: nil,
|
||||
related_person: nil,
|
||||
return_url: nil,
|
||||
type: nil,
|
||||
verification_flow: nil
|
||||
@ -267,6 +298,7 @@ module Stripe
|
||||
@provided_details = provided_details
|
||||
@related_customer = related_customer
|
||||
@related_customer_account = related_customer_account
|
||||
@related_person = related_person
|
||||
@return_url = return_url
|
||||
@type = type
|
||||
@verification_flow = verification_flow
|
||||
@ -381,6 +413,8 @@ module Stripe
|
||||
attr_reader :related_customer
|
||||
# Token referencing a Customer Account resource.
|
||||
attr_reader :related_customer_account
|
||||
# Attribute for field related_person
|
||||
attr_reader :related_person
|
||||
# Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
|
||||
attr_reader :status
|
||||
# The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
|
||||
|
||||
@ -4069,7 +4069,7 @@ module Stripe
|
||||
attr_accessor :billing_mode
|
||||
# A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
|
||||
attr_accessor :cancel_at_period_end
|
||||
# This simulates the subscription being canceled or expired immediately.
|
||||
attr_accessor :cancel_now
|
||||
|
||||
@ -834,10 +834,18 @@ module Stripe
|
||||
class Twint < Stripe::StripeObject; end
|
||||
|
||||
class UsBankAccount < Stripe::StripeObject
|
||||
# Account holder type: individual or company.
|
||||
class AchReturnAmount < 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).
|
||||
attr_reader :currency
|
||||
# A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
|
||||
attr_reader :value
|
||||
end
|
||||
# Attribute for field account_holder_type
|
||||
attr_reader :account_holder_type
|
||||
# Account type: checkings or savings. Defaults to checking if omitted.
|
||||
# Attribute for field account_type
|
||||
attr_reader :account_type
|
||||
# Amount of the ACH return to the bank account.
|
||||
attr_reader :ach_return_amount
|
||||
# Name of the bank associated with the bank account.
|
||||
attr_reader :bank_name
|
||||
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
|
||||
@ -846,7 +854,7 @@ module Stripe
|
||||
attr_reader :last4
|
||||
# ID of the mandate used to make this payment.
|
||||
attr_reader :mandate
|
||||
# Reference number to locate ACH payments with customer's bank.
|
||||
# Reference number to locate ACH payments with customer’s bank.
|
||||
attr_reader :payment_reference
|
||||
# Routing number of the bank account.
|
||||
attr_reader :routing_number
|
||||
@ -994,7 +1002,7 @@ module Stripe
|
||||
# An additional hash is included on `payment_method_details` with a name matching this value.
|
||||
# It contains information specific to the payment method.
|
||||
attr_reader :type
|
||||
# Attribute for field us_bank_account
|
||||
# Details of the US Bank Account used for this payment attempt.
|
||||
attr_reader :us_bank_account
|
||||
# Attribute for field wechat
|
||||
attr_reader :wechat
|
||||
|
||||
@ -832,10 +832,18 @@ module Stripe
|
||||
class Twint < Stripe::StripeObject; end
|
||||
|
||||
class UsBankAccount < Stripe::StripeObject
|
||||
# Account holder type: individual or company.
|
||||
class AchReturnAmount < 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).
|
||||
attr_reader :currency
|
||||
# A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
|
||||
attr_reader :value
|
||||
end
|
||||
# Attribute for field account_holder_type
|
||||
attr_reader :account_holder_type
|
||||
# Account type: checkings or savings. Defaults to checking if omitted.
|
||||
# Attribute for field account_type
|
||||
attr_reader :account_type
|
||||
# Amount of the ACH return to the bank account.
|
||||
attr_reader :ach_return_amount
|
||||
# Name of the bank associated with the bank account.
|
||||
attr_reader :bank_name
|
||||
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
|
||||
@ -844,7 +852,7 @@ module Stripe
|
||||
attr_reader :last4
|
||||
# ID of the mandate used to make this payment.
|
||||
attr_reader :mandate
|
||||
# Reference number to locate ACH payments with customer's bank.
|
||||
# Reference number to locate ACH payments with customer’s bank.
|
||||
attr_reader :payment_reference
|
||||
# Routing number of the bank account.
|
||||
attr_reader :routing_number
|
||||
@ -992,7 +1000,7 @@ module Stripe
|
||||
# An additional hash is included on `payment_method_details` with a name matching this value.
|
||||
# It contains information specific to the payment method.
|
||||
attr_reader :type
|
||||
# Attribute for field us_bank_account
|
||||
# Details of the US Bank Account used for this payment attempt.
|
||||
attr_reader :us_bank_account
|
||||
# Attribute for field wechat
|
||||
attr_reader :wechat
|
||||
|
||||
@ -889,7 +889,7 @@ module Stripe
|
||||
attr_accessor :billing_thresholds
|
||||
# A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
|
||||
attr_accessor :cancel_at_period_end
|
||||
# Details about why this subscription was cancelled
|
||||
attr_accessor :cancellation_details
|
||||
@ -1751,7 +1751,7 @@ module Stripe
|
||||
attr_accessor :add_invoice_items
|
||||
# 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).
|
||||
attr_accessor :application_fee_percent
|
||||
# Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
|
||||
# Automatic tax settings for this subscription.
|
||||
attr_accessor :automatic_tax
|
||||
# For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
|
||||
attr_accessor :backdate_start_date
|
||||
@ -1765,7 +1765,7 @@ module Stripe
|
||||
attr_accessor :billing_thresholds
|
||||
# A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
|
||||
attr_accessor :cancel_at_period_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`.
|
||||
attr_accessor :collection_method
|
||||
@ -1977,7 +1977,7 @@ module Stripe
|
||||
attr_reader :billing_thresholds
|
||||
# A date in the future at which the subscription will automatically get canceled
|
||||
attr_reader :cancel_at
|
||||
# Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. This field will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.
|
||||
attr_reader :cancel_at_period_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.
|
||||
attr_reader :canceled_at
|
||||
|
||||
@ -230,7 +230,7 @@ module Stripe
|
||||
attr_accessor :ownership_exemption_reason
|
||||
# The company's phone number (used for verification).
|
||||
attr_accessor :phone
|
||||
# Attribute for param field registration_date
|
||||
# When the business was incorporated or registered.
|
||||
attr_accessor :registration_date
|
||||
# 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).
|
||||
attr_accessor :registration_number
|
||||
|
||||
@ -89,19 +89,23 @@ module Stripe
|
||||
attr_accessor :limit
|
||||
# An object ID cursor for use in pagination.
|
||||
attr_accessor :starting_after
|
||||
# Only return FinancialAccounts that have the given status: `open` or `closed`
|
||||
attr_accessor :status
|
||||
|
||||
def initialize(
|
||||
created: nil,
|
||||
ending_before: nil,
|
||||
expand: nil,
|
||||
limit: nil,
|
||||
starting_after: nil
|
||||
starting_after: nil,
|
||||
status: nil
|
||||
)
|
||||
@created = created
|
||||
@ending_before = ending_before
|
||||
@expand = expand
|
||||
@limit = limit
|
||||
@starting_after = starting_after
|
||||
@status = status
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@ -3675,7 +3675,7 @@ module Stripe
|
||||
attr_accessor :ownership_exemption_reason
|
||||
# The company's phone number (used for verification).
|
||||
attr_accessor :phone
|
||||
# Attribute for param field registration_date
|
||||
# When the business was incorporated or registered.
|
||||
attr_accessor :registration_date
|
||||
# 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).
|
||||
attr_accessor :registration_number
|
||||
|
||||
@ -105,7 +105,7 @@ module Stripe
|
||||
@quantity = quantity
|
||||
end
|
||||
end
|
||||
# The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
|
||||
# The coupon or promotion code to apply to this subscription update.
|
||||
attr_accessor :discounts
|
||||
# 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.
|
||||
attr_accessor :items
|
||||
|
||||
@ -2164,7 +2164,7 @@ module Stripe
|
||||
attr_accessor :expires_at
|
||||
# Generate a post-purchase Invoice for one-time payments.
|
||||
attr_accessor :invoice_creation
|
||||
# A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
|
||||
# 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.
|
||||
#
|
||||
|
||||
@ -107,6 +107,18 @@ module Stripe
|
||||
@phone = phone
|
||||
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.
|
||||
attr_accessor :account
|
||||
# A token referencing a Person resource that this verification is being used to verify.
|
||||
attr_accessor :person
|
||||
|
||||
def initialize(account: nil, person: nil)
|
||||
@account = account
|
||||
@person = person
|
||||
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.
|
||||
attr_accessor :client_reference_id
|
||||
# Specifies which fields in the response should be expanded.
|
||||
@ -121,6 +133,8 @@ module Stripe
|
||||
attr_accessor :related_customer
|
||||
# Token referencing a Customer Account resource.
|
||||
attr_accessor :related_customer_account
|
||||
# Tokens referencing a Person resource and it's associated account.
|
||||
attr_accessor :related_person
|
||||
# The URL that the user will be redirected to upon completing the verification flow.
|
||||
attr_accessor :return_url
|
||||
# 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`.
|
||||
@ -136,6 +150,7 @@ module Stripe
|
||||
provided_details: nil,
|
||||
related_customer: nil,
|
||||
related_customer_account: nil,
|
||||
related_person: nil,
|
||||
return_url: nil,
|
||||
type: nil,
|
||||
verification_flow: nil
|
||||
@ -147,6 +162,7 @@ module Stripe
|
||||
@provided_details = provided_details
|
||||
@related_customer = related_customer
|
||||
@related_customer_account = related_customer_account
|
||||
@related_person = related_person
|
||||
@return_url = return_url
|
||||
@type = type
|
||||
@verification_flow = verification_flow
|
||||
|
||||
@ -3592,7 +3592,7 @@ module Stripe
|
||||
attr_accessor :billing_mode
|
||||
# A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
|
||||
attr_accessor :cancel_at_period_end
|
||||
# This simulates the subscription being canceled or expired immediately.
|
||||
attr_accessor :cancel_now
|
||||
|
||||
@ -651,7 +651,7 @@ module Stripe
|
||||
attr_accessor :billing_thresholds
|
||||
# A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
|
||||
attr_accessor :cancel_at_period_end
|
||||
# Details about why this subscription was cancelled
|
||||
attr_accessor :cancellation_details
|
||||
@ -1513,7 +1513,7 @@ module Stripe
|
||||
attr_accessor :add_invoice_items
|
||||
# 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).
|
||||
attr_accessor :application_fee_percent
|
||||
# Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
|
||||
# Automatic tax settings for this subscription.
|
||||
attr_accessor :automatic_tax
|
||||
# For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
|
||||
attr_accessor :backdate_start_date
|
||||
@ -1527,7 +1527,7 @@ module Stripe
|
||||
attr_accessor :billing_thresholds
|
||||
# A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
|
||||
attr_accessor :cancel_at_period_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`.
|
||||
attr_accessor :collection_method
|
||||
|
||||
@ -212,7 +212,7 @@ module Stripe
|
||||
attr_accessor :ownership_exemption_reason
|
||||
# The company's phone number (used for verification).
|
||||
attr_accessor :phone
|
||||
# Attribute for param field registration_date
|
||||
# When the business was incorporated or registered.
|
||||
attr_accessor :registration_date
|
||||
# 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).
|
||||
attr_accessor :registration_number
|
||||
|
||||
@ -39,19 +39,23 @@ module Stripe
|
||||
attr_accessor :limit
|
||||
# An object ID cursor for use in pagination.
|
||||
attr_accessor :starting_after
|
||||
# Only return FinancialAccounts that have the given status: `open` or `closed`
|
||||
attr_accessor :status
|
||||
|
||||
def initialize(
|
||||
created: nil,
|
||||
ending_before: nil,
|
||||
expand: nil,
|
||||
limit: nil,
|
||||
starting_after: nil
|
||||
starting_after: nil,
|
||||
status: nil
|
||||
)
|
||||
@created = created
|
||||
@ending_before = ending_before
|
||||
@expand = expand
|
||||
@limit = limit
|
||||
@starting_after = starting_after
|
||||
@status = status
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
156
rbi/stripe.rbi
156
rbi/stripe.rbi
@ -8917,7 +8917,7 @@ module Stripe
|
||||
# The company's phone number (used for verification).
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :phone
|
||||
# Attribute for param field registration_date
|
||||
# When the business was incorporated or registered.
|
||||
sig {
|
||||
returns(T.nilable(T.nilable(T.any(String, ::Stripe::Account::CreateParams::Company::RegistrationDate))))
|
||||
}
|
||||
@ -14385,7 +14385,7 @@ module Stripe
|
||||
sig { returns(Integer) }
|
||||
attr_reader :quantity
|
||||
end
|
||||
# The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
|
||||
# The coupon or promotion code to apply to this subscription update.
|
||||
sig { returns(T.nilable(T::Array[Discount])) }
|
||||
attr_reader :discounts
|
||||
# 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.
|
||||
@ -14550,7 +14550,7 @@ module Stripe
|
||||
}
|
||||
def initialize(id: nil, price: nil, quantity: nil); end
|
||||
end
|
||||
# The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
|
||||
# The coupon or promotion code to apply to this subscription update.
|
||||
sig {
|
||||
returns(T.nilable(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]))
|
||||
}
|
||||
@ -22793,7 +22793,7 @@ module Stripe
|
||||
# Generate a post-purchase Invoice for one-time payments.
|
||||
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation)) }
|
||||
attr_accessor :invoice_creation
|
||||
# A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
|
||||
# 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.
|
||||
#
|
||||
@ -32111,6 +32111,14 @@ module Stripe
|
||||
attr_reader :require_verification
|
||||
end
|
||||
class IdNumber < Stripe::StripeObject; end
|
||||
class Matching < Stripe::StripeObject
|
||||
# Strictness of the DOB matching policy to apply.
|
||||
sig { returns(String) }
|
||||
attr_reader :dob
|
||||
# Strictness of the name matching policy to apply.
|
||||
sig { returns(String) }
|
||||
attr_reader :name
|
||||
end
|
||||
class Phone < Stripe::StripeObject
|
||||
# Request one time password verification of `provided_details.phone`.
|
||||
sig { returns(T::Boolean) }
|
||||
@ -32125,6 +32133,9 @@ module Stripe
|
||||
# Attribute for field id_number
|
||||
sig { returns(IdNumber) }
|
||||
attr_reader :id_number
|
||||
# Attribute for field matching
|
||||
sig { returns(Matching) }
|
||||
attr_reader :matching
|
||||
# Attribute for field phone
|
||||
sig { returns(Phone) }
|
||||
attr_reader :phone
|
||||
@ -32142,6 +32153,14 @@ module Stripe
|
||||
sig { returns(String) }
|
||||
attr_reader :status
|
||||
end
|
||||
class RelatedPerson < Stripe::StripeObject
|
||||
# Token referencing the associated Account of the related Person resource.
|
||||
sig { returns(String) }
|
||||
attr_reader :account
|
||||
# Token referencing the related Person resource.
|
||||
sig { returns(String) }
|
||||
attr_reader :person
|
||||
end
|
||||
class VerifiedOutputs < Stripe::StripeObject
|
||||
class Address < Stripe::StripeObject
|
||||
# City, district, suburb, town, or village.
|
||||
@ -32250,6 +32269,9 @@ module Stripe
|
||||
# Token referencing a Customer Account resource.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :related_customer_account
|
||||
# Attribute for field related_person
|
||||
sig { returns(RelatedPerson) }
|
||||
attr_reader :related_person
|
||||
# Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
|
||||
sig { returns(String) }
|
||||
attr_reader :status
|
||||
@ -32373,6 +32395,16 @@ module Stripe
|
||||
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) }
|
||||
attr_accessor :account
|
||||
# A token referencing a Person resource that this verification is being used to verify.
|
||||
sig { returns(String) }
|
||||
attr_accessor :person
|
||||
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)) }
|
||||
attr_accessor :client_reference_id
|
||||
@ -32396,6 +32428,11 @@ module Stripe
|
||||
# Token referencing a Customer Account resource.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :related_customer_account
|
||||
# Tokens referencing a Person resource and it's associated account.
|
||||
sig {
|
||||
returns(T.nilable(::Stripe::Identity::VerificationSession::CreateParams::RelatedPerson))
|
||||
}
|
||||
attr_accessor :related_person
|
||||
# The URL that the user will be redirected to upon completing the verification flow.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :return_url
|
||||
@ -32406,7 +32443,7 @@ module Stripe
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :verification_flow
|
||||
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), return_url: T.nilable(String), type: T.nilable(String), verification_flow: T.nilable(String)).void
|
||||
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,
|
||||
@ -32416,6 +32453,7 @@ module Stripe
|
||||
provided_details: nil,
|
||||
related_customer: nil,
|
||||
related_customer_account: nil,
|
||||
related_person: nil,
|
||||
return_url: nil,
|
||||
type: nil,
|
||||
verification_flow: nil
|
||||
@ -37291,7 +37329,7 @@ module Stripe
|
||||
# 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.nilable(T.any(String, T.any(Integer, String))))) }
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# 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)) }
|
||||
attr_accessor :cancel_at_period_end
|
||||
# This simulates the subscription being canceled or expired immediately.
|
||||
@ -49575,12 +49613,23 @@ module Stripe
|
||||
end
|
||||
class Twint < Stripe::StripeObject; end
|
||||
class UsBankAccount < Stripe::StripeObject
|
||||
# Account holder type: individual or company.
|
||||
class AchReturnAmount < 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) }
|
||||
attr_reader :currency
|
||||
# A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
|
||||
sig { returns(Integer) }
|
||||
attr_reader :value
|
||||
end
|
||||
# Attribute for field account_holder_type
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :account_holder_type
|
||||
# Account type: checkings or savings. Defaults to checking if omitted.
|
||||
# Attribute for field account_type
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :account_type
|
||||
# Amount of the ACH return to the bank account.
|
||||
sig { returns(T.nilable(AchReturnAmount)) }
|
||||
attr_reader :ach_return_amount
|
||||
# Name of the bank associated with the bank account.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :bank_name
|
||||
@ -49593,7 +49642,7 @@ module Stripe
|
||||
# ID of the mandate used to make this payment.
|
||||
sig { returns(T.any(String, Stripe::Mandate)) }
|
||||
attr_reader :mandate
|
||||
# Reference number to locate ACH payments with customer's bank.
|
||||
# Reference number to locate ACH payments with customer’s bank.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :payment_reference
|
||||
# Routing number of the bank account.
|
||||
@ -49806,7 +49855,7 @@ module Stripe
|
||||
# It contains information specific to the payment method.
|
||||
sig { returns(String) }
|
||||
attr_reader :type
|
||||
# Attribute for field us_bank_account
|
||||
# Details of the US Bank Account used for this payment attempt.
|
||||
sig { returns(UsBankAccount) }
|
||||
attr_reader :us_bank_account
|
||||
# Attribute for field wechat
|
||||
@ -73872,12 +73921,23 @@ module Stripe
|
||||
end
|
||||
class Twint < Stripe::StripeObject; end
|
||||
class UsBankAccount < Stripe::StripeObject
|
||||
# Account holder type: individual or company.
|
||||
class AchReturnAmount < 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) }
|
||||
attr_reader :currency
|
||||
# A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
|
||||
sig { returns(Integer) }
|
||||
attr_reader :value
|
||||
end
|
||||
# Attribute for field account_holder_type
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :account_holder_type
|
||||
# Account type: checkings or savings. Defaults to checking if omitted.
|
||||
# Attribute for field account_type
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :account_type
|
||||
# Amount of the ACH return to the bank account.
|
||||
sig { returns(T.nilable(AchReturnAmount)) }
|
||||
attr_reader :ach_return_amount
|
||||
# Name of the bank associated with the bank account.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :bank_name
|
||||
@ -73890,7 +73950,7 @@ module Stripe
|
||||
# ID of the mandate used to make this payment.
|
||||
sig { returns(T.any(String, Stripe::Mandate)) }
|
||||
attr_reader :mandate
|
||||
# Reference number to locate ACH payments with customer's bank.
|
||||
# Reference number to locate ACH payments with customer’s bank.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :payment_reference
|
||||
# Routing number of the bank account.
|
||||
@ -74103,7 +74163,7 @@ module Stripe
|
||||
# It contains information specific to the payment method.
|
||||
sig { returns(String) }
|
||||
attr_reader :type
|
||||
# Attribute for field us_bank_account
|
||||
# Details of the US Bank Account used for this payment attempt.
|
||||
sig { returns(UsBankAccount) }
|
||||
attr_reader :us_bank_account
|
||||
# Attribute for field wechat
|
||||
@ -91113,7 +91173,7 @@ module Stripe
|
||||
# A date in the future at which the subscription will automatically get canceled
|
||||
sig { returns(T.nilable(Integer)) }
|
||||
attr_reader :cancel_at
|
||||
# Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. This field will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# 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) }
|
||||
attr_reader :cancel_at_period_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.
|
||||
@ -91932,7 +91992,7 @@ module Stripe
|
||||
# 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.nilable(T.any(String, T.any(Integer, String))))) }
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# 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)) }
|
||||
attr_accessor :cancel_at_period_end
|
||||
# Details about why this subscription was cancelled
|
||||
@ -92842,7 +92902,7 @@ module Stripe
|
||||
# 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.nilable(T.any(String, Float)))) }
|
||||
attr_accessor :application_fee_percent
|
||||
# Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
|
||||
# Automatic tax settings for this subscription.
|
||||
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::AutomaticTax)) }
|
||||
attr_accessor :automatic_tax
|
||||
# For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
|
||||
@ -92865,7 +92925,7 @@ module Stripe
|
||||
# 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))) }
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# 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)) }
|
||||
attr_accessor :cancel_at_period_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`.
|
||||
@ -102451,7 +102511,7 @@ module Stripe
|
||||
sig { returns(T.nilable(T.nilable(String))) }
|
||||
attr_accessor :configuration_overrides
|
||||
# A name for the location.
|
||||
sig { returns(T.nilable(String)) }
|
||||
sig { returns(T.nilable(T.nilable(String))) }
|
||||
attr_accessor :display_name
|
||||
# Specifies which fields in the response should be expanded.
|
||||
sig { returns(T.nilable(T::Array[String])) }
|
||||
@ -102460,7 +102520,7 @@ module Stripe
|
||||
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
||||
attr_accessor :metadata
|
||||
sig {
|
||||
params(address: T.nilable(::Stripe::Terminal::Location::UpdateParams::Address), configuration_overrides: T.nilable(T.nilable(String)), display_name: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
|
||||
params(address: T.nilable(::Stripe::Terminal::Location::UpdateParams::Address), configuration_overrides: T.nilable(T.nilable(String)), display_name: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
|
||||
}
|
||||
def initialize(
|
||||
address: nil,
|
||||
@ -104022,7 +104082,7 @@ module Stripe
|
||||
# The company's phone number (used for verification).
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :phone
|
||||
# Attribute for param field registration_date
|
||||
# When the business was incorporated or registered.
|
||||
sig {
|
||||
returns(T.nilable(T.nilable(T.any(String, ::Stripe::Token::CreateParams::Account::Company::RegistrationDate))))
|
||||
}
|
||||
@ -105893,15 +105953,19 @@ module Stripe
|
||||
# An object ID cursor for use in pagination.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :starting_after
|
||||
# Only return FinancialAccounts that have the given status: `open` or `closed`
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :status
|
||||
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)).void
|
||||
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
|
||||
starting_after: nil,
|
||||
status: nil
|
||||
); end
|
||||
end
|
||||
class CreateParams < Stripe::RequestParams
|
||||
@ -113233,7 +113297,7 @@ module Stripe
|
||||
# The company's phone number (used for verification).
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :phone
|
||||
# Attribute for param field registration_date
|
||||
# When the business was incorporated or registered.
|
||||
sig {
|
||||
returns(T.nilable(T.nilable(T.any(String, ::Stripe::AccountService::CreateParams::Company::RegistrationDate))))
|
||||
}
|
||||
@ -118705,7 +118769,7 @@ module Stripe
|
||||
}
|
||||
def initialize(id: nil, price: nil, quantity: nil); end
|
||||
end
|
||||
# The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
|
||||
# The coupon or promotion code to apply to this subscription update.
|
||||
sig {
|
||||
returns(T.nilable(T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]))
|
||||
}
|
||||
@ -123246,7 +123310,7 @@ module Stripe
|
||||
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation))
|
||||
}
|
||||
attr_accessor :invoice_creation
|
||||
# A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
|
||||
# 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.
|
||||
#
|
||||
@ -131544,6 +131608,16 @@ module Stripe
|
||||
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) }
|
||||
attr_accessor :account
|
||||
# A token referencing a Person resource that this verification is being used to verify.
|
||||
sig { returns(String) }
|
||||
attr_accessor :person
|
||||
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)) }
|
||||
attr_accessor :client_reference_id
|
||||
@ -131569,6 +131643,11 @@ module Stripe
|
||||
# Token referencing a Customer Account resource.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :related_customer_account
|
||||
# Tokens referencing a Person resource and it's associated account.
|
||||
sig {
|
||||
returns(T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::RelatedPerson))
|
||||
}
|
||||
attr_accessor :related_person
|
||||
# The URL that the user will be redirected to upon completing the verification flow.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :return_url
|
||||
@ -131579,7 +131658,7 @@ module Stripe
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :verification_flow
|
||||
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), return_url: T.nilable(String), type: T.nilable(String), verification_flow: T.nilable(String)).void
|
||||
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,
|
||||
@ -131589,6 +131668,7 @@ module Stripe
|
||||
provided_details: nil,
|
||||
related_customer: nil,
|
||||
related_customer_account: nil,
|
||||
related_person: nil,
|
||||
return_url: nil,
|
||||
type: nil,
|
||||
verification_flow: nil
|
||||
@ -135622,7 +135702,7 @@ module Stripe
|
||||
# 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.nilable(T.any(String, T.any(Integer, String))))) }
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# 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)) }
|
||||
attr_accessor :cancel_at_period_end
|
||||
# This simulates the subscription being canceled or expired immediately.
|
||||
@ -171533,7 +171613,7 @@ module Stripe
|
||||
# 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.nilable(T.any(String, T.any(Integer, String))))) }
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# 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)) }
|
||||
attr_accessor :cancel_at_period_end
|
||||
# Details about why this subscription was cancelled
|
||||
@ -172453,7 +172533,7 @@ module Stripe
|
||||
# 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.nilable(T.any(String, Float)))) }
|
||||
attr_accessor :application_fee_percent
|
||||
# Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
|
||||
# Automatic tax settings for this subscription.
|
||||
sig { returns(T.nilable(::Stripe::SubscriptionService::CreateParams::AutomaticTax)) }
|
||||
attr_accessor :automatic_tax
|
||||
# For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
|
||||
@ -172478,7 +172558,7 @@ module Stripe
|
||||
# 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))) }
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# 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)) }
|
||||
attr_accessor :cancel_at_period_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`.
|
||||
@ -179481,7 +179561,7 @@ module Stripe
|
||||
sig { returns(T.nilable(T.nilable(String))) }
|
||||
attr_accessor :configuration_overrides
|
||||
# A name for the location.
|
||||
sig { returns(T.nilable(String)) }
|
||||
sig { returns(T.nilable(T.nilable(String))) }
|
||||
attr_accessor :display_name
|
||||
# Specifies which fields in the response should be expanded.
|
||||
sig { returns(T.nilable(T::Array[String])) }
|
||||
@ -179490,7 +179570,7 @@ module Stripe
|
||||
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
||||
attr_accessor :metadata
|
||||
sig {
|
||||
params(address: T.nilable(::Stripe::Terminal::LocationService::UpdateParams::Address), configuration_overrides: T.nilable(T.nilable(String)), display_name: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
|
||||
params(address: T.nilable(::Stripe::Terminal::LocationService::UpdateParams::Address), configuration_overrides: T.nilable(T.nilable(String)), display_name: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
|
||||
}
|
||||
def initialize(
|
||||
address: nil,
|
||||
@ -180401,7 +180481,7 @@ module Stripe
|
||||
# The company's phone number (used for verification).
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :phone
|
||||
# Attribute for param field registration_date
|
||||
# When the business was incorporated or registered.
|
||||
sig {
|
||||
returns(T.nilable(T.nilable(T.any(String, ::Stripe::TokenService::CreateParams::Account::Company::RegistrationDate))))
|
||||
}
|
||||
@ -182065,15 +182145,19 @@ module Stripe
|
||||
# An object ID cursor for use in pagination.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :starting_after
|
||||
# Only return FinancialAccounts that have the given status: `open` or `closed`
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :status
|
||||
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)).void
|
||||
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
|
||||
starting_after: nil,
|
||||
status: nil
|
||||
); end
|
||||
end
|
||||
class CreateParams < Stripe::RequestParams
|
||||
|
||||
@ -4449,7 +4449,7 @@ module Stripe
|
||||
# The company's phone number (used for verification).
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :phone
|
||||
# Attribute for param field registration_date
|
||||
# When the business was incorporated or registered.
|
||||
sig {
|
||||
returns(T.nilable(T.nilable(T.any(String, ::Stripe::Account::CreateParams::Company::RegistrationDate))))
|
||||
}
|
||||
|
||||
@ -87,7 +87,7 @@ module Stripe
|
||||
sig { returns(Integer) }
|
||||
attr_reader :quantity
|
||||
end
|
||||
# The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
|
||||
# The coupon or promotion code to apply to this subscription update.
|
||||
sig { returns(T.nilable(T::Array[Discount])) }
|
||||
attr_reader :discounts
|
||||
# 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.
|
||||
@ -252,7 +252,7 @@ module Stripe
|
||||
}
|
||||
def initialize(id: nil, price: nil, quantity: nil); end
|
||||
end
|
||||
# The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
|
||||
# The coupon or promotion code to apply to this subscription update.
|
||||
sig {
|
||||
returns(T.nilable(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]))
|
||||
}
|
||||
|
||||
@ -3782,7 +3782,7 @@ module Stripe
|
||||
# Generate a post-purchase Invoice for one-time payments.
|
||||
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation)) }
|
||||
attr_accessor :invoice_creation
|
||||
# A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
|
||||
# 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.
|
||||
#
|
||||
|
||||
@ -45,6 +45,14 @@ module Stripe
|
||||
attr_reader :require_verification
|
||||
end
|
||||
class IdNumber < Stripe::StripeObject; end
|
||||
class Matching < Stripe::StripeObject
|
||||
# Strictness of the DOB matching policy to apply.
|
||||
sig { returns(String) }
|
||||
attr_reader :dob
|
||||
# Strictness of the name matching policy to apply.
|
||||
sig { returns(String) }
|
||||
attr_reader :name
|
||||
end
|
||||
class Phone < Stripe::StripeObject
|
||||
# Request one time password verification of `provided_details.phone`.
|
||||
sig { returns(T::Boolean) }
|
||||
@ -59,6 +67,9 @@ module Stripe
|
||||
# Attribute for field id_number
|
||||
sig { returns(IdNumber) }
|
||||
attr_reader :id_number
|
||||
# Attribute for field matching
|
||||
sig { returns(Matching) }
|
||||
attr_reader :matching
|
||||
# Attribute for field phone
|
||||
sig { returns(Phone) }
|
||||
attr_reader :phone
|
||||
@ -76,6 +87,14 @@ module Stripe
|
||||
sig { returns(String) }
|
||||
attr_reader :status
|
||||
end
|
||||
class RelatedPerson < Stripe::StripeObject
|
||||
# Token referencing the associated Account of the related Person resource.
|
||||
sig { returns(String) }
|
||||
attr_reader :account
|
||||
# Token referencing the related Person resource.
|
||||
sig { returns(String) }
|
||||
attr_reader :person
|
||||
end
|
||||
class VerifiedOutputs < Stripe::StripeObject
|
||||
class Address < Stripe::StripeObject
|
||||
# City, district, suburb, town, or village.
|
||||
@ -184,6 +203,9 @@ module Stripe
|
||||
# Token referencing a Customer Account resource.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :related_customer_account
|
||||
# Attribute for field related_person
|
||||
sig { returns(RelatedPerson) }
|
||||
attr_reader :related_person
|
||||
# Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
|
||||
sig { returns(String) }
|
||||
attr_reader :status
|
||||
@ -307,6 +329,16 @@ module Stripe
|
||||
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) }
|
||||
attr_accessor :account
|
||||
# A token referencing a Person resource that this verification is being used to verify.
|
||||
sig { returns(String) }
|
||||
attr_accessor :person
|
||||
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)) }
|
||||
attr_accessor :client_reference_id
|
||||
@ -330,6 +362,11 @@ module Stripe
|
||||
# Token referencing a Customer Account resource.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :related_customer_account
|
||||
# Tokens referencing a Person resource and it's associated account.
|
||||
sig {
|
||||
returns(T.nilable(::Stripe::Identity::VerificationSession::CreateParams::RelatedPerson))
|
||||
}
|
||||
attr_accessor :related_person
|
||||
# The URL that the user will be redirected to upon completing the verification flow.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :return_url
|
||||
@ -340,7 +377,7 @@ module Stripe
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :verification_flow
|
||||
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), return_url: T.nilable(String), type: T.nilable(String), verification_flow: T.nilable(String)).void
|
||||
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,
|
||||
@ -350,6 +387,7 @@ module Stripe
|
||||
provided_details: nil,
|
||||
related_customer: nil,
|
||||
related_customer_account: nil,
|
||||
related_person: nil,
|
||||
return_url: nil,
|
||||
type: nil,
|
||||
verification_flow: nil
|
||||
|
||||
@ -4691,7 +4691,7 @@ module Stripe
|
||||
# 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.nilable(T.any(String, T.any(Integer, String))))) }
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# 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)) }
|
||||
attr_accessor :cancel_at_period_end
|
||||
# This simulates the subscription being canceled or expired immediately.
|
||||
|
||||
@ -1040,12 +1040,23 @@ module Stripe
|
||||
end
|
||||
class Twint < Stripe::StripeObject; end
|
||||
class UsBankAccount < Stripe::StripeObject
|
||||
# Account holder type: individual or company.
|
||||
class AchReturnAmount < 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) }
|
||||
attr_reader :currency
|
||||
# A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
|
||||
sig { returns(Integer) }
|
||||
attr_reader :value
|
||||
end
|
||||
# Attribute for field account_holder_type
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :account_holder_type
|
||||
# Account type: checkings or savings. Defaults to checking if omitted.
|
||||
# Attribute for field account_type
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :account_type
|
||||
# Amount of the ACH return to the bank account.
|
||||
sig { returns(T.nilable(AchReturnAmount)) }
|
||||
attr_reader :ach_return_amount
|
||||
# Name of the bank associated with the bank account.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :bank_name
|
||||
@ -1058,7 +1069,7 @@ module Stripe
|
||||
# ID of the mandate used to make this payment.
|
||||
sig { returns(T.any(String, Stripe::Mandate)) }
|
||||
attr_reader :mandate
|
||||
# Reference number to locate ACH payments with customer's bank.
|
||||
# Reference number to locate ACH payments with customer’s bank.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :payment_reference
|
||||
# Routing number of the bank account.
|
||||
@ -1271,7 +1282,7 @@ module Stripe
|
||||
# It contains information specific to the payment method.
|
||||
sig { returns(String) }
|
||||
attr_reader :type
|
||||
# Attribute for field us_bank_account
|
||||
# Details of the US Bank Account used for this payment attempt.
|
||||
sig { returns(UsBankAccount) }
|
||||
attr_reader :us_bank_account
|
||||
# Attribute for field wechat
|
||||
|
||||
@ -1040,12 +1040,23 @@ module Stripe
|
||||
end
|
||||
class Twint < Stripe::StripeObject; end
|
||||
class UsBankAccount < Stripe::StripeObject
|
||||
# Account holder type: individual or company.
|
||||
class AchReturnAmount < 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) }
|
||||
attr_reader :currency
|
||||
# A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
|
||||
sig { returns(Integer) }
|
||||
attr_reader :value
|
||||
end
|
||||
# Attribute for field account_holder_type
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :account_holder_type
|
||||
# Account type: checkings or savings. Defaults to checking if omitted.
|
||||
# Attribute for field account_type
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :account_type
|
||||
# Amount of the ACH return to the bank account.
|
||||
sig { returns(T.nilable(AchReturnAmount)) }
|
||||
attr_reader :ach_return_amount
|
||||
# Name of the bank associated with the bank account.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :bank_name
|
||||
@ -1058,7 +1069,7 @@ module Stripe
|
||||
# ID of the mandate used to make this payment.
|
||||
sig { returns(T.any(String, Stripe::Mandate)) }
|
||||
attr_reader :mandate
|
||||
# Reference number to locate ACH payments with customer's bank.
|
||||
# Reference number to locate ACH payments with customer’s bank.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_reader :payment_reference
|
||||
# Routing number of the bank account.
|
||||
@ -1271,7 +1282,7 @@ module Stripe
|
||||
# It contains information specific to the payment method.
|
||||
sig { returns(String) }
|
||||
attr_reader :type
|
||||
# Attribute for field us_bank_account
|
||||
# Details of the US Bank Account used for this payment attempt.
|
||||
sig { returns(UsBankAccount) }
|
||||
attr_reader :us_bank_account
|
||||
# Attribute for field wechat
|
||||
|
||||
@ -325,7 +325,7 @@ module Stripe
|
||||
# A date in the future at which the subscription will automatically get canceled
|
||||
sig { returns(T.nilable(Integer)) }
|
||||
attr_reader :cancel_at
|
||||
# Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. This field will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# 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) }
|
||||
attr_reader :cancel_at_period_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.
|
||||
@ -1144,7 +1144,7 @@ module Stripe
|
||||
# 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.nilable(T.any(String, T.any(Integer, String))))) }
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# 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)) }
|
||||
attr_accessor :cancel_at_period_end
|
||||
# Details about why this subscription was cancelled
|
||||
@ -2054,7 +2054,7 @@ module Stripe
|
||||
# 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.nilable(T.any(String, Float)))) }
|
||||
attr_accessor :application_fee_percent
|
||||
# Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
|
||||
# Automatic tax settings for this subscription.
|
||||
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::AutomaticTax)) }
|
||||
attr_accessor :automatic_tax
|
||||
# For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
|
||||
@ -2077,7 +2077,7 @@ module Stripe
|
||||
# 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))) }
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# 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)) }
|
||||
attr_accessor :cancel_at_period_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`.
|
||||
|
||||
@ -92,7 +92,7 @@ module Stripe
|
||||
sig { returns(T.nilable(T.nilable(String))) }
|
||||
attr_accessor :configuration_overrides
|
||||
# A name for the location.
|
||||
sig { returns(T.nilable(String)) }
|
||||
sig { returns(T.nilable(T.nilable(String))) }
|
||||
attr_accessor :display_name
|
||||
# Specifies which fields in the response should be expanded.
|
||||
sig { returns(T.nilable(T::Array[String])) }
|
||||
@ -101,7 +101,7 @@ module Stripe
|
||||
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
||||
attr_accessor :metadata
|
||||
sig {
|
||||
params(address: T.nilable(::Stripe::Terminal::Location::UpdateParams::Address), configuration_overrides: T.nilable(T.nilable(String)), display_name: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
|
||||
params(address: T.nilable(::Stripe::Terminal::Location::UpdateParams::Address), configuration_overrides: T.nilable(T.nilable(String)), display_name: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
|
||||
}
|
||||
def initialize(
|
||||
address: nil,
|
||||
|
||||
@ -281,7 +281,7 @@ module Stripe
|
||||
# The company's phone number (used for verification).
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :phone
|
||||
# Attribute for param field registration_date
|
||||
# When the business was incorporated or registered.
|
||||
sig {
|
||||
returns(T.nilable(T.nilable(T.any(String, ::Stripe::Token::CreateParams::Account::Company::RegistrationDate))))
|
||||
}
|
||||
|
||||
@ -158,15 +158,19 @@ module Stripe
|
||||
# An object ID cursor for use in pagination.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :starting_after
|
||||
# Only return FinancialAccounts that have the given status: `open` or `closed`
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :status
|
||||
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)).void
|
||||
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
|
||||
starting_after: nil,
|
||||
status: nil
|
||||
); end
|
||||
end
|
||||
class CreateParams < Stripe::RequestParams
|
||||
|
||||
@ -3718,7 +3718,7 @@ module Stripe
|
||||
# The company's phone number (used for verification).
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :phone
|
||||
# Attribute for param field registration_date
|
||||
# When the business was incorporated or registered.
|
||||
sig {
|
||||
returns(T.nilable(T.nilable(T.any(String, ::Stripe::AccountService::CreateParams::Company::RegistrationDate))))
|
||||
}
|
||||
|
||||
@ -108,7 +108,7 @@ module Stripe
|
||||
}
|
||||
def initialize(id: nil, price: nil, quantity: nil); end
|
||||
end
|
||||
# The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
|
||||
# The coupon or promotion code to apply to this subscription update.
|
||||
sig {
|
||||
returns(T.nilable(T::Array[::Stripe::BillingPortal::SessionService::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]))
|
||||
}
|
||||
|
||||
@ -2295,7 +2295,7 @@ module Stripe
|
||||
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation))
|
||||
}
|
||||
attr_accessor :invoice_creation
|
||||
# A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
|
||||
# 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.
|
||||
#
|
||||
|
||||
@ -113,6 +113,16 @@ module Stripe
|
||||
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) }
|
||||
attr_accessor :account
|
||||
# A token referencing a Person resource that this verification is being used to verify.
|
||||
sig { returns(String) }
|
||||
attr_accessor :person
|
||||
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)) }
|
||||
attr_accessor :client_reference_id
|
||||
@ -138,6 +148,11 @@ module Stripe
|
||||
# Token referencing a Customer Account resource.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :related_customer_account
|
||||
# Tokens referencing a Person resource and it's associated account.
|
||||
sig {
|
||||
returns(T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::RelatedPerson))
|
||||
}
|
||||
attr_accessor :related_person
|
||||
# The URL that the user will be redirected to upon completing the verification flow.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :return_url
|
||||
@ -148,7 +163,7 @@ module Stripe
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :verification_flow
|
||||
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), return_url: T.nilable(String), type: T.nilable(String), verification_flow: T.nilable(String)).void
|
||||
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,
|
||||
@ -158,6 +173,7 @@ module Stripe
|
||||
provided_details: nil,
|
||||
related_customer: nil,
|
||||
related_customer_account: nil,
|
||||
related_person: nil,
|
||||
return_url: nil,
|
||||
type: nil,
|
||||
verification_flow: nil
|
||||
|
||||
@ -3863,7 +3863,7 @@ module Stripe
|
||||
# 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.nilable(T.any(String, T.any(Integer, String))))) }
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# 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)) }
|
||||
attr_accessor :cancel_at_period_end
|
||||
# This simulates the subscription being canceled or expired immediately.
|
||||
|
||||
@ -711,7 +711,7 @@ module Stripe
|
||||
# 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.nilable(T.any(String, T.any(Integer, String))))) }
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# 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)) }
|
||||
attr_accessor :cancel_at_period_end
|
||||
# Details about why this subscription was cancelled
|
||||
@ -1631,7 +1631,7 @@ module Stripe
|
||||
# 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.nilable(T.any(String, Float)))) }
|
||||
attr_accessor :application_fee_percent
|
||||
# Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
|
||||
# Automatic tax settings for this subscription.
|
||||
sig { returns(T.nilable(::Stripe::SubscriptionService::CreateParams::AutomaticTax)) }
|
||||
attr_accessor :automatic_tax
|
||||
# For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
|
||||
@ -1656,7 +1656,7 @@ module Stripe
|
||||
# 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))) }
|
||||
attr_accessor :cancel_at
|
||||
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
||||
# 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)) }
|
||||
attr_accessor :cancel_at_period_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`.
|
||||
|
||||
@ -52,7 +52,7 @@ module Stripe
|
||||
sig { returns(T.nilable(T.nilable(String))) }
|
||||
attr_accessor :configuration_overrides
|
||||
# A name for the location.
|
||||
sig { returns(T.nilable(String)) }
|
||||
sig { returns(T.nilable(T.nilable(String))) }
|
||||
attr_accessor :display_name
|
||||
# Specifies which fields in the response should be expanded.
|
||||
sig { returns(T.nilable(T::Array[String])) }
|
||||
@ -61,7 +61,7 @@ module Stripe
|
||||
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
||||
attr_accessor :metadata
|
||||
sig {
|
||||
params(address: T.nilable(::Stripe::Terminal::LocationService::UpdateParams::Address), configuration_overrides: T.nilable(T.nilable(String)), display_name: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
|
||||
params(address: T.nilable(::Stripe::Terminal::LocationService::UpdateParams::Address), configuration_overrides: T.nilable(T.nilable(String)), display_name: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
|
||||
}
|
||||
def initialize(
|
||||
address: nil,
|
||||
|
||||
@ -237,7 +237,7 @@ module Stripe
|
||||
# The company's phone number (used for verification).
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :phone
|
||||
# Attribute for param field registration_date
|
||||
# When the business was incorporated or registered.
|
||||
sig {
|
||||
returns(T.nilable(T.nilable(T.any(String, ::Stripe::TokenService::CreateParams::Account::Company::RegistrationDate))))
|
||||
}
|
||||
|
||||
@ -42,15 +42,19 @@ module Stripe
|
||||
# An object ID cursor for use in pagination.
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :starting_after
|
||||
# Only return FinancialAccounts that have the given status: `open` or `closed`
|
||||
sig { returns(T.nilable(String)) }
|
||||
attr_accessor :status
|
||||
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)).void
|
||||
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
|
||||
starting_after: nil,
|
||||
status: nil
|
||||
); end
|
||||
end
|
||||
class CreateParams < Stripe::RequestParams
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user