stripe 15.0.0 → 15.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/API_VERSION +1 -0
- data/CHANGELOG.md +129 -44
- data/CONTRIBUTING.md +25 -0
- data/Gemfile +1 -1
- data/OPENAPI_VERSION +1 -1
- data/README.md +28 -55
- data/VERSION +1 -1
- data/lib/stripe/api_operations/nested_resource.rb +35 -35
- data/lib/stripe/api_requestor.rb +1 -1
- data/lib/stripe/api_version.rb +2 -1
- data/lib/stripe/connection_manager.rb +1 -3
- data/lib/stripe/event_types.rb +1 -0
- data/lib/stripe/events/v1_billing_meter_error_report_triggered_event.rb +1 -1
- data/lib/stripe/events/v1_billing_meter_no_meter_found_event.rb +1 -1
- data/lib/stripe/events/v2_core_event_destination_ping_event.rb +21 -0
- data/lib/stripe/oauth.rb +1 -1
- data/lib/stripe/resources/account.rb +198 -28
- data/lib/stripe/resources/account_session.rb +176 -72
- data/lib/stripe/resources/apple_pay_domain.rb +1 -2
- data/lib/stripe/resources/balance.rb +42 -0
- data/lib/stripe/resources/balance_transaction.rb +2 -0
- data/lib/stripe/resources/bank_account.rb +2 -2
- data/lib/stripe/resources/billing_portal/session.rb +3 -3
- data/lib/stripe/resources/capability.rb +1 -1
- data/lib/stripe/resources/charge.rb +43 -20
- data/lib/stripe/resources/checkout/session.rb +120 -19
- data/lib/stripe/resources/confirmation_token.rb +119 -100
- data/lib/stripe/resources/country_spec.rb +1 -1
- data/lib/stripe/resources/coupon.rb +2 -3
- data/lib/stripe/resources/credit_note.rb +21 -18
- data/lib/stripe/resources/customer.rb +4 -6
- data/lib/stripe/resources/customer_session.rb +5 -5
- data/lib/stripe/resources/dispute.rb +2 -2
- data/lib/stripe/resources/event.rb +3 -1
- data/lib/stripe/resources/file.rb +1 -1
- data/lib/stripe/resources/funding_instructions.rb +1 -1
- data/lib/stripe/resources/identity/verification_report.rb +6 -0
- data/lib/stripe/resources/identity/verification_session.rb +51 -11
- data/lib/stripe/resources/invoice.rb +146 -32
- data/lib/stripe/resources/invoice_item.rb +3 -7
- data/lib/stripe/resources/invoice_line_item.rb +1 -1
- data/lib/stripe/resources/invoice_payment.rb +9 -2
- data/lib/stripe/resources/issuing/authorization.rb +8 -8
- data/lib/stripe/resources/issuing/card.rb +1 -1
- data/lib/stripe/resources/issuing/dispute.rb +3 -3
- data/lib/stripe/resources/login_link.rb +2 -1
- data/lib/stripe/resources/mandate.rb +3 -0
- data/lib/stripe/resources/payment_intent.rb +602 -325
- data/lib/stripe/resources/payment_method.rb +76 -117
- data/lib/stripe/resources/payment_method_configuration.rb +356 -2
- data/lib/stripe/resources/payment_method_domain.rb +15 -2
- data/lib/stripe/resources/payout.rb +4 -4
- data/lib/stripe/resources/person.rb +27 -3
- data/lib/stripe/resources/plan.rb +2 -3
- data/lib/stripe/resources/price.rb +1 -1
- data/lib/stripe/resources/product.rb +1 -2
- data/lib/stripe/resources/quote.rb +28 -3
- data/lib/stripe/resources/radar/value_list.rb +1 -2
- data/lib/stripe/resources/radar/value_list_item.rb +1 -2
- data/lib/stripe/resources/refund.rb +8 -1
- data/lib/stripe/resources/reversal.rb +1 -1
- data/lib/stripe/resources/review.rb +1 -1
- data/lib/stripe/resources/setup_attempt.rb +1 -1
- data/lib/stripe/resources/setup_intent.rb +414 -293
- data/lib/stripe/resources/source.rb +1 -1
- data/lib/stripe/resources/subscription.rb +149 -27
- data/lib/stripe/resources/subscription_item.rb +33 -0
- data/lib/stripe/resources/subscription_schedule.rb +141 -4
- data/lib/stripe/resources/tax/calculation.rb +6 -2
- data/lib/stripe/resources/tax/calculation_line_item.rb +2 -0
- data/lib/stripe/resources/tax/registration.rb +261 -1
- data/lib/stripe/resources/tax/transaction.rb +1 -1
- data/lib/stripe/resources/tax_id.rb +3 -4
- data/lib/stripe/resources/tax_rate.rb +2 -2
- data/lib/stripe/resources/terminal/configuration.rb +2 -2
- data/lib/stripe/resources/terminal/location.rb +2 -3
- data/lib/stripe/resources/terminal/reader.rb +426 -6
- data/lib/stripe/resources/test_helpers/test_clock.rb +1 -2
- data/lib/stripe/resources/token.rb +63 -2
- data/lib/stripe/resources/transfer.rb +1 -1
- data/lib/stripe/resources/treasury/financial_account.rb +5 -1
- data/lib/stripe/resources/v2/billing/meter_event.rb +2 -2
- data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +2 -2
- data/lib/stripe/resources/v2/billing/meter_event_session.rb +2 -2
- data/lib/stripe/resources/v2/event.rb +2 -2
- data/lib/stripe/resources/v2/event_destination.rb +2 -2
- data/lib/stripe/resources/webhook_endpoint.rb +1 -2
- data/lib/stripe/resources.rb +1 -0
- data/lib/stripe/services/account_external_account_service.rb +3 -4
- data/lib/stripe/services/account_login_link_service.rb +1 -1
- data/lib/stripe/services/account_person_service.rb +85 -2
- data/lib/stripe/services/account_service.rb +169 -20
- data/lib/stripe/services/account_session_service.rb +115 -47
- data/lib/stripe/services/apple_pay_domain_service.rb +1 -2
- data/lib/stripe/services/application_fee_service.rb +1 -1
- data/lib/stripe/services/apps_service.rb +1 -1
- data/lib/stripe/services/balance_service.rb +1 -1
- data/lib/stripe/services/billing/meter_service.rb +1 -1
- data/lib/stripe/services/billing_portal/session_service.rb +1 -1
- data/lib/stripe/services/billing_portal_service.rb +1 -1
- data/lib/stripe/services/billing_service.rb +1 -1
- data/lib/stripe/services/charge_service.rb +4 -4
- data/lib/stripe/services/checkout/session_service.rb +94 -15
- data/lib/stripe/services/checkout_service.rb +1 -1
- data/lib/stripe/services/climate_service.rb +1 -1
- data/lib/stripe/services/coupon_service.rb +1 -2
- data/lib/stripe/services/credit_note_preview_lines_service.rb +3 -3
- data/lib/stripe/services/credit_note_service.rb +14 -15
- data/lib/stripe/services/customer_balance_transaction_service.rb +3 -3
- data/lib/stripe/services/customer_cash_balance_transaction_service.rb +2 -2
- data/lib/stripe/services/customer_payment_method_service.rb +1 -1
- data/lib/stripe/services/customer_payment_source_service.rb +1 -1
- data/lib/stripe/services/customer_service.rb +5 -7
- data/lib/stripe/services/customer_session_service.rb +1 -1
- data/lib/stripe/services/customer_tax_id_service.rb +2 -3
- data/lib/stripe/services/dispute_service.rb +1 -1
- data/lib/stripe/services/entitlements_service.rb +1 -1
- data/lib/stripe/services/file_service.rb +1 -1
- data/lib/stripe/services/financial_connections/account_service.rb +1 -1
- data/lib/stripe/services/financial_connections_service.rb +1 -1
- data/lib/stripe/services/forwarding_service.rb +1 -1
- data/lib/stripe/services/identity/verification_session_service.rb +21 -5
- data/lib/stripe/services/identity_service.rb +1 -1
- data/lib/stripe/services/invoice_item_service.rb +1 -2
- data/lib/stripe/services/invoice_service.rb +122 -28
- data/lib/stripe/services/issuing/authorization_service.rb +4 -4
- data/lib/stripe/services/issuing/card_service.rb +1 -1
- data/lib/stripe/services/issuing/dispute_service.rb +2 -2
- data/lib/stripe/services/issuing_service.rb +1 -1
- data/lib/stripe/services/payment_intent_service.rb +563 -313
- data/lib/stripe/services/payment_link_service.rb +1 -1
- data/lib/stripe/services/payment_method_configuration_service.rb +254 -2
- data/lib/stripe/services/payment_method_domain_service.rb +1 -1
- data/lib/stripe/services/payment_method_service.rb +59 -105
- data/lib/stripe/services/payout_service.rb +2 -2
- data/lib/stripe/services/plan_service.rb +2 -3
- data/lib/stripe/services/price_service.rb +2 -2
- data/lib/stripe/services/product_feature_service.rb +1 -2
- data/lib/stripe/services/product_service.rb +3 -4
- data/lib/stripe/services/promotion_code_service.rb +1 -1
- data/lib/stripe/services/quote_service.rb +21 -4
- data/lib/stripe/services/radar/early_fraud_warning_service.rb +1 -1
- data/lib/stripe/services/radar/value_list_item_service.rb +1 -2
- data/lib/stripe/services/radar/value_list_service.rb +1 -2
- data/lib/stripe/services/radar_service.rb +1 -1
- data/lib/stripe/services/reporting_service.rb +1 -1
- data/lib/stripe/services/setup_intent_service.rb +403 -291
- data/lib/stripe/services/sigma_service.rb +1 -1
- data/lib/stripe/services/source_service.rb +2 -2
- data/lib/stripe/services/subscription_item_service.rb +26 -0
- data/lib/stripe/services/subscription_schedule_service.rb +106 -3
- data/lib/stripe/services/subscription_service.rb +121 -26
- data/lib/stripe/services/tax/calculation_service.rb +6 -2
- data/lib/stripe/services/tax/registration_service.rb +170 -1
- data/lib/stripe/services/tax/transaction_service.rb +1 -1
- data/lib/stripe/services/tax_id_service.rb +2 -3
- data/lib/stripe/services/tax_service.rb +1 -1
- data/lib/stripe/services/terminal/configuration_service.rb +1 -2
- data/lib/stripe/services/terminal/location_service.rb +2 -3
- data/lib/stripe/services/terminal/reader_service.rb +196 -2
- data/lib/stripe/services/terminal_service.rb +1 -1
- data/lib/stripe/services/test_helpers/confirmation_token_service.rb +90 -91
- data/lib/stripe/services/test_helpers/issuing_service.rb +1 -1
- data/lib/stripe/services/test_helpers/terminal/reader_service.rb +43 -0
- data/lib/stripe/services/test_helpers/terminal_service.rb +1 -1
- data/lib/stripe/services/test_helpers/test_clock_service.rb +1 -2
- data/lib/stripe/services/test_helpers/treasury_service.rb +1 -1
- data/lib/stripe/services/test_helpers_service.rb +1 -1
- data/lib/stripe/services/token_service.rb +62 -1
- data/lib/stripe/services/transfer_service.rb +2 -2
- data/lib/stripe/services/treasury/financial_account_service.rb +6 -2
- data/lib/stripe/services/treasury_service.rb +1 -1
- data/lib/stripe/services/v1_services.rb +1 -1
- data/lib/stripe/services/v2/billing/meter_event_session_service.rb +1 -2
- data/lib/stripe/services/v2/billing_service.rb +3 -3
- data/lib/stripe/services/v2/core/event_destination_service.rb +17 -23
- data/lib/stripe/services/v2/core/event_service.rb +1 -2
- data/lib/stripe/services/v2/core_service.rb +1 -1
- data/lib/stripe/services/v2_services.rb +1 -1
- data/lib/stripe/services/webhook_endpoint_service.rb +1 -2
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe/webhook.rb +1 -1
- data/rbi/stripe/resources/account.rbi +190 -35
- data/rbi/stripe/resources/account_session.rbi +196 -77
- data/rbi/stripe/resources/apple_pay_domain.rbi +1 -3
- data/rbi/stripe/resources/balance.rbi +55 -0
- data/rbi/stripe/resources/balance_transaction.rbi +3 -0
- data/rbi/stripe/resources/bank_account.rbi +2 -2
- data/rbi/stripe/resources/billing/alert.rbi +2 -2
- data/rbi/stripe/resources/billing_portal/session.rbi +3 -3
- data/rbi/stripe/resources/capability.rbi +1 -1
- data/rbi/stripe/resources/charge.rbi +52 -20
- data/rbi/stripe/resources/checkout/session.rbi +133 -24
- data/rbi/stripe/resources/confirmation_token.rbi +140 -115
- data/rbi/stripe/resources/country_spec.rbi +1 -1
- data/rbi/stripe/resources/coupon.rbi +2 -4
- data/rbi/stripe/resources/credit_note.rbi +23 -18
- data/rbi/stripe/resources/customer.rbi +4 -8
- data/rbi/stripe/resources/customer_session.rbi +5 -5
- data/rbi/stripe/resources/dispute.rbi +2 -2
- data/rbi/stripe/resources/event.rbi +4 -1
- data/rbi/stripe/resources/file.rbi +1 -1
- data/rbi/stripe/resources/identity/verification_report.rbi +9 -0
- data/rbi/stripe/resources/identity/verification_session.rbi +59 -12
- data/rbi/stripe/resources/invoice.rbi +149 -40
- data/rbi/stripe/resources/invoice_item.rbi +3 -8
- data/rbi/stripe/resources/invoice_line_item.rbi +2 -2
- data/rbi/stripe/resources/invoice_payment.rbi +9 -2
- data/rbi/stripe/resources/issuing/authorization.rbi +8 -8
- data/rbi/stripe/resources/issuing/card.rbi +1 -1
- data/rbi/stripe/resources/issuing/dispute.rbi +3 -3
- data/rbi/stripe/resources/login_link.rbi +2 -1
- data/rbi/stripe/resources/mandate.rbi +4 -0
- data/rbi/stripe/resources/payment_intent.rbi +637 -381
- data/rbi/stripe/resources/payment_method.rbi +81 -133
- data/rbi/stripe/resources/payment_method_configuration.rbi +400 -4
- data/rbi/stripe/resources/payment_method_domain.rbi +18 -2
- data/rbi/stripe/resources/payout.rbi +4 -4
- data/rbi/stripe/resources/person.rbi +33 -3
- data/rbi/stripe/resources/plan.rbi +2 -4
- data/rbi/stripe/resources/price.rbi +1 -1
- data/rbi/stripe/resources/product.rbi +1 -3
- data/rbi/stripe/resources/quote.rbi +25 -3
- data/rbi/stripe/resources/radar/value_list.rbi +1 -3
- data/rbi/stripe/resources/radar/value_list_item.rbi +1 -3
- data/rbi/stripe/resources/refund.rbi +8 -1
- data/rbi/stripe/resources/reversal.rbi +1 -1
- data/rbi/stripe/resources/review.rbi +1 -1
- data/rbi/stripe/resources/setup_attempt.rbi +1 -1
- data/rbi/stripe/resources/setup_intent.rbi +464 -346
- data/rbi/stripe/resources/source.rbi +1 -1
- data/rbi/stripe/resources/subscription.rbi +150 -34
- data/rbi/stripe/resources/subscription_item.rbi +36 -2
- data/rbi/stripe/resources/subscription_schedule.rbi +161 -11
- data/rbi/stripe/resources/tax/calculation.rbi +7 -3
- data/rbi/stripe/resources/tax/calculation_line_item.rbi +4 -1
- data/rbi/stripe/resources/tax/registration.rbi +249 -2
- data/rbi/stripe/resources/tax/transaction.rbi +1 -1
- data/rbi/stripe/resources/tax_id.rbi +3 -5
- data/rbi/stripe/resources/tax_rate.rbi +2 -2
- data/rbi/stripe/resources/terminal/configuration.rbi +2 -3
- data/rbi/stripe/resources/terminal/location.rbi +4 -6
- data/rbi/stripe/resources/terminal/reader.rbi +415 -8
- data/rbi/stripe/resources/test_helpers/test_clock.rbi +1 -3
- data/rbi/stripe/resources/token.rbi +70 -4
- data/rbi/stripe/resources/transfer.rbi +1 -1
- data/rbi/stripe/resources/treasury/financial_account.rbi +6 -2
- data/rbi/stripe/resources/v2/billing/meter_event.rbi +3 -3
- data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +3 -3
- data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +3 -3
- data/rbi/stripe/resources/v2/event.rbi +3 -3
- data/rbi/stripe/resources/v2/event_destination.rbi +3 -3
- data/rbi/stripe/resources/webhook_endpoint.rbi +1 -3
- data/rbi/stripe/services/account_external_account_service.rbi +3 -5
- data/rbi/stripe/services/account_login_link_service.rbi +1 -1
- data/rbi/stripe/services/account_person_service.rbi +93 -5
- data/rbi/stripe/services/account_service.rbi +166 -28
- data/rbi/stripe/services/account_session_service.rbi +126 -52
- data/rbi/stripe/services/apple_pay_domain_service.rbi +1 -3
- data/rbi/stripe/services/balance_service.rbi +1 -1
- data/rbi/stripe/services/billing/alert_service.rbi +2 -2
- data/rbi/stripe/services/billing_portal/session_service.rbi +1 -1
- data/rbi/stripe/services/charge_service.rbi +4 -4
- data/rbi/stripe/services/checkout/session_service.rbi +104 -19
- data/rbi/stripe/services/coupon_service.rbi +1 -3
- data/rbi/stripe/services/credit_note_preview_lines_service.rbi +3 -3
- data/rbi/stripe/services/credit_note_service.rbi +13 -14
- data/rbi/stripe/services/customer_balance_transaction_service.rbi +3 -3
- data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +2 -2
- data/rbi/stripe/services/customer_payment_method_service.rbi +1 -1
- data/rbi/stripe/services/customer_payment_source_service.rbi +1 -1
- data/rbi/stripe/services/customer_service.rbi +4 -8
- data/rbi/stripe/services/customer_session_service.rbi +1 -1
- data/rbi/stripe/services/customer_tax_id_service.rbi +2 -4
- data/rbi/stripe/services/dispute_service.rbi +1 -1
- data/rbi/stripe/services/file_service.rbi +1 -1
- data/rbi/stripe/services/identity/verification_session_service.rbi +22 -6
- data/rbi/stripe/services/invoice_item_service.rbi +1 -3
- data/rbi/stripe/services/invoice_service.rbi +126 -35
- data/rbi/stripe/services/issuing/authorization_service.rbi +4 -4
- data/rbi/stripe/services/issuing/card_service.rbi +1 -1
- data/rbi/stripe/services/issuing/dispute_service.rbi +2 -2
- data/rbi/stripe/services/payment_intent_service.rbi +599 -369
- data/rbi/stripe/services/payment_method_configuration_service.rbi +280 -4
- data/rbi/stripe/services/payment_method_domain_service.rbi +1 -1
- data/rbi/stripe/services/payment_method_service.rbi +62 -121
- data/rbi/stripe/services/payout_service.rbi +2 -2
- data/rbi/stripe/services/plan_service.rbi +2 -4
- data/rbi/stripe/services/price_service.rbi +2 -2
- data/rbi/stripe/services/product_feature_service.rbi +1 -3
- data/rbi/stripe/services/product_service.rbi +2 -4
- data/rbi/stripe/services/promotion_code_service.rbi +1 -1
- data/rbi/stripe/services/quote_service.rbi +16 -3
- data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +1 -1
- data/rbi/stripe/services/radar/value_list_item_service.rbi +1 -3
- data/rbi/stripe/services/radar/value_list_service.rbi +1 -3
- data/rbi/stripe/services/setup_intent_service.rbi +457 -344
- data/rbi/stripe/services/source_service.rbi +1 -1
- data/rbi/stripe/services/subscription_item_service.rbi +28 -2
- data/rbi/stripe/services/subscription_schedule_service.rbi +119 -10
- data/rbi/stripe/services/subscription_service.rbi +121 -33
- data/rbi/stripe/services/tax/calculation_service.rbi +6 -2
- data/rbi/stripe/services/tax/registration_service.rbi +171 -2
- data/rbi/stripe/services/tax_id_service.rbi +2 -4
- data/rbi/stripe/services/terminal/configuration_service.rbi +1 -3
- data/rbi/stripe/services/terminal/location_service.rbi +4 -6
- data/rbi/stripe/services/terminal/reader_service.rbi +200 -4
- data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +106 -106
- data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +31 -0
- data/rbi/stripe/services/test_helpers/test_clock_service.rbi +1 -3
- data/rbi/stripe/services/token_service.rbi +71 -3
- data/rbi/stripe/services/transfer_service.rbi +1 -1
- data/rbi/stripe/services/treasury/financial_account_service.rbi +6 -2
- data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +1 -3
- data/rbi/stripe/services/v2/billing_service.rbi +1 -1
- data/rbi/stripe/services/v2/core/event_destination_service.rbi +14 -22
- data/rbi/stripe/services/v2/core/event_service.rbi +1 -3
- data/rbi/stripe/services/webhook_endpoint_service.rbi +1 -3
- metadata +5 -2
@@ -27,7 +27,7 @@ module Stripe
|
|
27
27
|
# Stripe applies any customer credit on the account before determining the
|
28
28
|
# amount due for the invoice (i.e., the amount that will be actually
|
29
29
|
# charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge
|
30
|
-
# per currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the
|
30
|
+
# per currency](https://docs.stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the
|
31
31
|
# invoice is automatically marked paid, and we add the amount due to the
|
32
32
|
# customer's credit balance which is applied to the next invoice.
|
33
33
|
#
|
@@ -54,6 +54,9 @@ module Stripe
|
|
54
54
|
# 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.
|
55
55
|
sig { returns(T.nilable(Liability)) }
|
56
56
|
attr_reader :liability
|
57
|
+
# The tax provider powering automatic tax.
|
58
|
+
sig { returns(T.nilable(String)) }
|
59
|
+
attr_reader :provider
|
57
60
|
# The status of the most recent automated tax calculation for this invoice.
|
58
61
|
sig { returns(T.nilable(String)) }
|
59
62
|
attr_reader :status
|
@@ -132,7 +135,7 @@ module Stripe
|
|
132
135
|
attr_reader :tracking_number
|
133
136
|
end
|
134
137
|
class CustomerTaxId < Stripe::StripeObject
|
135
|
-
# 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`, or `unknown`
|
138
|
+
# 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`
|
136
139
|
sig { returns(String) }
|
137
140
|
attr_reader :type
|
138
141
|
# The value of the tax ID.
|
@@ -672,7 +675,7 @@ module Stripe
|
|
672
675
|
# 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.
|
673
676
|
sig { returns(T.nilable(String)) }
|
674
677
|
attr_reader :hosted_invoice_url
|
675
|
-
# Unique identifier for the object.
|
678
|
+
# 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`.
|
676
679
|
sig { returns(String) }
|
677
680
|
attr_reader :id
|
678
681
|
# The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
|
@@ -786,9 +789,7 @@ module Stripe
|
|
786
789
|
# Always true for a deleted object
|
787
790
|
sig { returns(T::Boolean) }
|
788
791
|
attr_reader :deleted
|
789
|
-
class DeleteParams < Stripe::RequestParams
|
790
|
-
|
791
|
-
end
|
792
|
+
class DeleteParams < Stripe::RequestParams; end
|
792
793
|
class UpdateParams < Stripe::RequestParams
|
793
794
|
class AutomaticTax < Stripe::RequestParams
|
794
795
|
class Liability < Stripe::RequestParams
|
@@ -887,7 +888,7 @@ module Stripe
|
|
887
888
|
# One of `month`.
|
888
889
|
sig { returns(T.nilable(String)) }
|
889
890
|
attr_accessor :interval
|
890
|
-
# Type of installment plan, one of `fixed_count`.
|
891
|
+
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
|
891
892
|
sig { returns(String) }
|
892
893
|
attr_accessor :type
|
893
894
|
sig {
|
@@ -959,12 +960,8 @@ module Stripe
|
|
959
960
|
}
|
960
961
|
def initialize(bank_transfer: nil, funding_type: nil); end
|
961
962
|
end
|
962
|
-
class Konbini < Stripe::RequestParams
|
963
|
-
|
964
|
-
end
|
965
|
-
class SepaDebit < Stripe::RequestParams
|
966
|
-
|
967
|
-
end
|
963
|
+
class Konbini < Stripe::RequestParams; end
|
964
|
+
class SepaDebit < Stripe::RequestParams; end
|
968
965
|
class UsBankAccount < Stripe::RequestParams
|
969
966
|
class FinancialConnections < Stripe::RequestParams
|
970
967
|
class Filters < Stripe::RequestParams
|
@@ -1583,7 +1580,7 @@ module Stripe
|
|
1583
1580
|
# One of `month`.
|
1584
1581
|
sig { returns(T.nilable(String)) }
|
1585
1582
|
attr_accessor :interval
|
1586
|
-
# Type of installment plan, one of `fixed_count`.
|
1583
|
+
# Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
|
1587
1584
|
sig { returns(String) }
|
1588
1585
|
attr_accessor :type
|
1589
1586
|
sig {
|
@@ -1655,12 +1652,8 @@ module Stripe
|
|
1655
1652
|
}
|
1656
1653
|
def initialize(bank_transfer: nil, funding_type: nil); end
|
1657
1654
|
end
|
1658
|
-
class Konbini < Stripe::RequestParams
|
1659
|
-
|
1660
|
-
end
|
1661
|
-
class SepaDebit < Stripe::RequestParams
|
1662
|
-
|
1663
|
-
end
|
1655
|
+
class Konbini < Stripe::RequestParams; end
|
1656
|
+
class SepaDebit < Stripe::RequestParams; end
|
1664
1657
|
class UsBankAccount < Stripe::RequestParams
|
1665
1658
|
class FinancialConnections < Stripe::RequestParams
|
1666
1659
|
class Filters < Stripe::RequestParams
|
@@ -2354,6 +2347,16 @@ module Stripe
|
|
2354
2347
|
}
|
2355
2348
|
def initialize(expand: nil, invoice_metadata: nil, lines: nil); end
|
2356
2349
|
end
|
2350
|
+
class AttachPaymentParams < Stripe::RequestParams
|
2351
|
+
# Specifies which fields in the response should be expanded.
|
2352
|
+
sig { returns(T.nilable(T::Array[String])) }
|
2353
|
+
attr_accessor :expand
|
2354
|
+
# The ID of the PaymentIntent to attach to the invoice.
|
2355
|
+
sig { returns(T.nilable(String)) }
|
2356
|
+
attr_accessor :payment_intent
|
2357
|
+
sig { params(expand: T.nilable(T::Array[String]), payment_intent: T.nilable(String)).void }
|
2358
|
+
def initialize(expand: nil, payment_intent: nil); end
|
2359
|
+
end
|
2357
2360
|
class FinalizeInvoiceParams < Stripe::RequestParams
|
2358
2361
|
# 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.
|
2359
2362
|
sig { returns(T.nilable(T::Boolean)) }
|
@@ -2792,7 +2795,7 @@ module Stripe
|
|
2792
2795
|
def initialize(ip_address: nil); end
|
2793
2796
|
end
|
2794
2797
|
class TaxId < Stripe::RequestParams
|
2795
|
-
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `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`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `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`, `kh_tin`, `kr_brn`, `kz_bin`, `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`
|
2798
|
+
# 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`
|
2796
2799
|
sig { returns(String) }
|
2797
2800
|
attr_accessor :type
|
2798
2801
|
# Value of the tax ID.
|
@@ -2978,6 +2981,13 @@ module Stripe
|
|
2978
2981
|
def initialize(account: nil, type: nil); end
|
2979
2982
|
end
|
2980
2983
|
class ScheduleDetails < Stripe::RequestParams
|
2984
|
+
class BillingMode < Stripe::RequestParams
|
2985
|
+
# Attribute for param field type
|
2986
|
+
sig { returns(String) }
|
2987
|
+
attr_accessor :type
|
2988
|
+
sig { params(type: String).void }
|
2989
|
+
def initialize(type: nil); end
|
2990
|
+
end
|
2981
2991
|
class Phase < Stripe::RequestParams
|
2982
2992
|
class AddInvoiceItem < Stripe::RequestParams
|
2983
2993
|
class Discount < Stripe::RequestParams
|
@@ -3076,6 +3086,18 @@ module Stripe
|
|
3076
3086
|
}
|
3077
3087
|
def initialize(enabled: nil, liability: nil); end
|
3078
3088
|
end
|
3089
|
+
class BillingThresholds < Stripe::RequestParams
|
3090
|
+
# Monetary threshold that triggers the subscription to advance to a new billing period
|
3091
|
+
sig { returns(T.nilable(Integer)) }
|
3092
|
+
attr_accessor :amount_gte
|
3093
|
+
# 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.
|
3094
|
+
sig { returns(T.nilable(T::Boolean)) }
|
3095
|
+
attr_accessor :reset_billing_cycle_anchor
|
3096
|
+
sig {
|
3097
|
+
params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void
|
3098
|
+
}
|
3099
|
+
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
|
3100
|
+
end
|
3079
3101
|
class Discount < Stripe::RequestParams
|
3080
3102
|
# ID of the coupon to create a new discount for.
|
3081
3103
|
sig { returns(T.nilable(String)) }
|
@@ -3119,6 +3141,13 @@ module Stripe
|
|
3119
3141
|
def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end
|
3120
3142
|
end
|
3121
3143
|
class Item < Stripe::RequestParams
|
3144
|
+
class BillingThresholds < Stripe::RequestParams
|
3145
|
+
# 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))
|
3146
|
+
sig { returns(Integer) }
|
3147
|
+
attr_accessor :usage_gte
|
3148
|
+
sig { params(usage_gte: Integer).void }
|
3149
|
+
def initialize(usage_gte: nil); end
|
3150
|
+
end
|
3122
3151
|
class Discount < Stripe::RequestParams
|
3123
3152
|
# ID of the coupon to create a new discount for.
|
3124
3153
|
sig { returns(T.nilable(String)) }
|
@@ -3177,6 +3206,11 @@ module Stripe
|
|
3177
3206
|
unit_amount_decimal: nil
|
3178
3207
|
); end
|
3179
3208
|
end
|
3209
|
+
# 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.
|
3210
|
+
sig {
|
3211
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::BillingThresholds))))
|
3212
|
+
}
|
3213
|
+
attr_accessor :billing_thresholds
|
3180
3214
|
# The coupons to redeem into discounts for the subscription item.
|
3181
3215
|
sig {
|
3182
3216
|
returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount]))))
|
@@ -3203,9 +3237,10 @@ module Stripe
|
|
3203
3237
|
sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
|
3204
3238
|
attr_accessor :tax_rates
|
3205
3239
|
sig {
|
3206
|
-
params(discounts: T.nilable(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.nilable(T.any(String, T::Array[String])))).void
|
3240
|
+
params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::BillingThresholds))), discounts: T.nilable(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.nilable(T.any(String, T::Array[String])))).void
|
3207
3241
|
}
|
3208
3242
|
def initialize(
|
3243
|
+
billing_thresholds: nil,
|
3209
3244
|
discounts: nil,
|
3210
3245
|
metadata: nil,
|
3211
3246
|
plan: nil,
|
@@ -3241,6 +3276,11 @@ module Stripe
|
|
3241
3276
|
# 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).
|
3242
3277
|
sig { returns(T.nilable(String)) }
|
3243
3278
|
attr_accessor :billing_cycle_anchor
|
3279
|
+
# 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.
|
3280
|
+
sig {
|
3281
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds))))
|
3282
|
+
}
|
3283
|
+
attr_accessor :billing_thresholds
|
3244
3284
|
# 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.
|
3245
3285
|
sig { returns(T.nilable(String)) }
|
3246
3286
|
attr_accessor :collection_method
|
@@ -3283,7 +3323,7 @@ module Stripe
|
|
3283
3323
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
3284
3324
|
sig { returns(T.nilable(String)) }
|
3285
3325
|
attr_accessor :on_behalf_of
|
3286
|
-
#
|
3326
|
+
# 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.
|
3287
3327
|
sig { returns(T.nilable(String)) }
|
3288
3328
|
attr_accessor :proration_behavior
|
3289
3329
|
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
|
@@ -3301,13 +3341,14 @@ module Stripe
|
|
3301
3341
|
sig { returns(T.nilable(T.any(Integer, String))) }
|
3302
3342
|
attr_accessor :trial_end
|
3303
3343
|
sig {
|
3304
|
-
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), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount]))), 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], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), 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_end: T.nilable(T.any(Integer, String))).void
|
3344
|
+
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.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.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount]))), 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], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), 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_end: T.nilable(T.any(Integer, String))).void
|
3305
3345
|
}
|
3306
3346
|
def initialize(
|
3307
3347
|
add_invoice_items: nil,
|
3308
3348
|
application_fee_percent: nil,
|
3309
3349
|
automatic_tax: nil,
|
3310
3350
|
billing_cycle_anchor: nil,
|
3351
|
+
billing_thresholds: nil,
|
3311
3352
|
collection_method: nil,
|
3312
3353
|
currency: nil,
|
3313
3354
|
default_payment_method: nil,
|
@@ -3327,6 +3368,11 @@ module Stripe
|
|
3327
3368
|
trial_end: nil
|
3328
3369
|
); end
|
3329
3370
|
end
|
3371
|
+
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
3372
|
+
sig {
|
3373
|
+
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::BillingMode))
|
3374
|
+
}
|
3375
|
+
attr_accessor :billing_mode
|
3330
3376
|
# 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.
|
3331
3377
|
sig { returns(T.nilable(String)) }
|
3332
3378
|
attr_accessor :end_behavior
|
@@ -3339,12 +3385,31 @@ module Stripe
|
|
3339
3385
|
sig { returns(T.nilable(String)) }
|
3340
3386
|
attr_accessor :proration_behavior
|
3341
3387
|
sig {
|
3342
|
-
params(end_behavior: T.nilable(String), phases: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase]), proration_behavior: T.nilable(String)).void
|
3388
|
+
params(billing_mode: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::BillingMode), end_behavior: T.nilable(String), phases: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase]), proration_behavior: T.nilable(String)).void
|
3343
3389
|
}
|
3344
|
-
def initialize(
|
3390
|
+
def initialize(
|
3391
|
+
billing_mode: nil,
|
3392
|
+
end_behavior: nil,
|
3393
|
+
phases: nil,
|
3394
|
+
proration_behavior: nil
|
3395
|
+
); end
|
3345
3396
|
end
|
3346
3397
|
class SubscriptionDetails < Stripe::RequestParams
|
3398
|
+
class BillingMode < Stripe::RequestParams
|
3399
|
+
# Attribute for param field type
|
3400
|
+
sig { returns(String) }
|
3401
|
+
attr_accessor :type
|
3402
|
+
sig { params(type: String).void }
|
3403
|
+
def initialize(type: nil); end
|
3404
|
+
end
|
3347
3405
|
class Item < Stripe::RequestParams
|
3406
|
+
class BillingThresholds < Stripe::RequestParams
|
3407
|
+
# 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))
|
3408
|
+
sig { returns(Integer) }
|
3409
|
+
attr_accessor :usage_gte
|
3410
|
+
sig { params(usage_gte: Integer).void }
|
3411
|
+
def initialize(usage_gte: nil); end
|
3412
|
+
end
|
3348
3413
|
class Discount < Stripe::RequestParams
|
3349
3414
|
# ID of the coupon to create a new discount for.
|
3350
3415
|
sig { returns(T.nilable(String)) }
|
@@ -3403,6 +3468,11 @@ module Stripe
|
|
3403
3468
|
unit_amount_decimal: nil
|
3404
3469
|
); end
|
3405
3470
|
end
|
3471
|
+
# 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.
|
3472
|
+
sig {
|
3473
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::BillingThresholds))))
|
3474
|
+
}
|
3475
|
+
attr_accessor :billing_thresholds
|
3406
3476
|
# 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.
|
3407
3477
|
sig { returns(T.nilable(T::Boolean)) }
|
3408
3478
|
attr_accessor :clear_usage
|
@@ -3438,9 +3508,10 @@ module Stripe
|
|
3438
3508
|
sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
|
3439
3509
|
attr_accessor :tax_rates
|
3440
3510
|
sig {
|
3441
|
-
params(clear_usage: T.nilable(T::Boolean), deleted: T.nilable(T::Boolean), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount]))), id: T.nilable(String), metadata: T.nilable(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.nilable(T.any(String, T::Array[String])))).void
|
3511
|
+
params(billing_thresholds: T.nilable(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.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount]))), id: T.nilable(String), metadata: T.nilable(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.nilable(T.any(String, T::Array[String])))).void
|
3442
3512
|
}
|
3443
3513
|
def initialize(
|
3514
|
+
billing_thresholds: nil,
|
3444
3515
|
clear_usage: nil,
|
3445
3516
|
deleted: nil,
|
3446
3517
|
discounts: nil,
|
@@ -3456,6 +3527,11 @@ module Stripe
|
|
3456
3527
|
# 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`.
|
3457
3528
|
sig { returns(T.nilable(T.any(String, Integer))) }
|
3458
3529
|
attr_accessor :billing_cycle_anchor
|
3530
|
+
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
3531
|
+
sig {
|
3532
|
+
returns(T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::BillingMode))
|
3533
|
+
}
|
3534
|
+
attr_accessor :billing_mode
|
3459
3535
|
# 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.
|
3460
3536
|
sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) }
|
3461
3537
|
attr_accessor :cancel_at
|
@@ -3489,10 +3565,11 @@ module Stripe
|
|
3489
3565
|
sig { returns(T.nilable(T.any(String, Integer))) }
|
3490
3566
|
attr_accessor :trial_end
|
3491
3567
|
sig {
|
3492
|
-
params(billing_cycle_anchor: T.nilable(T.any(String, Integer)), cancel_at: T.nilable(T.nilable(T.any(String, Integer))), cancel_at_period_end: T.nilable(T::Boolean), cancel_now: T.nilable(T::Boolean), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), items: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item]), 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
|
3568
|
+
params(billing_cycle_anchor: T.nilable(T.any(String, Integer)), billing_mode: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::BillingMode), cancel_at: T.nilable(T.nilable(T.any(String, Integer))), cancel_at_period_end: T.nilable(T::Boolean), cancel_now: T.nilable(T::Boolean), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), items: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item]), 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
|
3493
3569
|
}
|
3494
3570
|
def initialize(
|
3495
3571
|
billing_cycle_anchor: nil,
|
3572
|
+
billing_mode: nil,
|
3496
3573
|
cancel_at: nil,
|
3497
3574
|
cancel_at_period_end: nil,
|
3498
3575
|
cancel_now: nil,
|
@@ -3581,17 +3658,49 @@ module Stripe
|
|
3581
3658
|
}
|
3582
3659
|
def self.add_lines(invoice, params = {}, opts = {}); end
|
3583
3660
|
|
3584
|
-
#
|
3661
|
+
# Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
|
3662
|
+
#
|
3663
|
+
# For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
|
3664
|
+
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
|
3665
|
+
# invoice's status becomes paid.
|
3666
|
+
#
|
3667
|
+
# If the PaymentIntent's status is already succeeded when it's attached, it's
|
3668
|
+
# credited to the invoice immediately.
|
3669
|
+
#
|
3670
|
+
# See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more.
|
3671
|
+
sig {
|
3672
|
+
params(params: T.any(::Stripe::Invoice::AttachPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
|
3673
|
+
}
|
3674
|
+
def attach_payment(params = {}, opts = {}); end
|
3675
|
+
|
3676
|
+
# Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
|
3677
|
+
#
|
3678
|
+
# For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
|
3679
|
+
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
|
3680
|
+
# invoice's status becomes paid.
|
3681
|
+
#
|
3682
|
+
# If the PaymentIntent's status is already succeeded when it's attached, it's
|
3683
|
+
# credited to the invoice immediately.
|
3684
|
+
#
|
3685
|
+
# See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more.
|
3686
|
+
sig {
|
3687
|
+
params(invoice: String, params: T.any(::Stripe::Invoice::AttachPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
|
3688
|
+
}
|
3689
|
+
def self.attach_payment(invoice, params = {}, opts = {}); end
|
3690
|
+
|
3691
|
+
# 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 <a href="#send_invoice">send](https://docs.stripe.com/api#finalize_invoice) the invoice to your customers.
|
3585
3692
|
sig {
|
3586
3693
|
params(params: T.any(::Stripe::Invoice::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
|
3587
3694
|
}
|
3588
3695
|
def self.create(params = {}, opts = {}); end
|
3589
3696
|
|
3590
|
-
# At any time, you can preview the upcoming invoice for a
|
3697
|
+
# 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.
|
3591
3698
|
#
|
3592
|
-
#
|
3699
|
+
# 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.
|
3700
|
+
#
|
3701
|
+
# 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.
|
3593
3702
|
#
|
3594
|
-
#
|
3703
|
+
# 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.
|
3595
3704
|
#
|
3596
3705
|
# 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)
|
3597
3706
|
sig {
|
@@ -3599,13 +3708,13 @@ module Stripe
|
|
3599
3708
|
}
|
3600
3709
|
def self.create_preview(params = {}, opts = {}); end
|
3601
3710
|
|
3602
|
-
# 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://stripe.com/
|
3711
|
+
# 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).
|
3603
3712
|
sig {
|
3604
3713
|
params(invoice: String, params: T.any(::Stripe::Invoice::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
|
3605
3714
|
}
|
3606
3715
|
def self.delete(invoice, params = {}, opts = {}); end
|
3607
3716
|
|
3608
|
-
# 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://stripe.com/
|
3717
|
+
# 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).
|
3609
3718
|
sig {
|
3610
3719
|
params(params: T.any(::Stripe::Invoice::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
|
3611
3720
|
}
|
@@ -3691,11 +3800,11 @@ module Stripe
|
|
3691
3800
|
}
|
3692
3801
|
def self.send_invoice(invoice, params = {}, opts = {}); end
|
3693
3802
|
|
3694
|
-
# Draft invoices are fully editable. Once an invoice is [finalized](https://stripe.com/docs/billing/invoices/workflow#finalized),
|
3803
|
+
# Draft invoices are fully editable. Once an invoice is [finalized](https://docs.stripe.com/docs/billing/invoices/workflow#finalized),
|
3695
3804
|
# monetary values, as well as collection_method, become uneditable.
|
3696
3805
|
#
|
3697
3806
|
# If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,
|
3698
|
-
# sending reminders for, or [automatically reconciling](https://stripe.com/docs/billing/invoices/reconciliation) invoices, pass
|
3807
|
+
# sending reminders for, or [automatically reconciling](https://docs.stripe.com/docs/billing/invoices/reconciliation) invoices, pass
|
3699
3808
|
# auto_advance=false.
|
3700
3809
|
sig {
|
3701
3810
|
params(invoice: String, params: T.any(::Stripe::Invoice::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
|
@@ -3714,17 +3823,17 @@ module Stripe
|
|
3714
3823
|
}
|
3715
3824
|
def self.update_lines(invoice, params = {}, opts = {}); end
|
3716
3825
|
|
3717
|
-
# Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/
|
3826
|
+
# 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.
|
3718
3827
|
#
|
3719
|
-
# 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 <a href="#create_credit_note">credit note](https://stripe.com/
|
3828
|
+
# 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 <a href="#create_credit_note">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.
|
3720
3829
|
sig {
|
3721
3830
|
params(params: T.any(::Stripe::Invoice::VoidInvoiceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
|
3722
3831
|
}
|
3723
3832
|
def void_invoice(params = {}, opts = {}); end
|
3724
3833
|
|
3725
|
-
# Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/
|
3834
|
+
# 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.
|
3726
3835
|
#
|
3727
|
-
# 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 <a href="#create_credit_note">credit note](https://stripe.com/
|
3836
|
+
# 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 <a href="#create_credit_note">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.
|
3728
3837
|
sig {
|
3729
3838
|
params(invoice: String, params: T.any(::Stripe::Invoice::VoidInvoiceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice)
|
3730
3839
|
}
|
@@ -3,10 +3,7 @@
|
|
3
3
|
|
4
4
|
# typed: true
|
5
5
|
module Stripe
|
6
|
-
# Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices).
|
7
|
-
# invoice by creating or updating it with an `invoice` field, at which point it will be included as
|
8
|
-
# [an invoice line item](https://stripe.com/docs/api/invoices/line_item) within
|
9
|
-
# [invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines).
|
6
|
+
# 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).
|
10
7
|
#
|
11
8
|
# Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined
|
12
9
|
# with a [subscription](https://stripe.com/docs/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge
|
@@ -94,7 +91,7 @@ module Stripe
|
|
94
91
|
# String representing the object's type. Objects of the same type share the same value.
|
95
92
|
sig { returns(String) }
|
96
93
|
attr_reader :object
|
97
|
-
# The parent that generated this invoice
|
94
|
+
# The parent that generated this invoice item.
|
98
95
|
sig { returns(T.nilable(Parent)) }
|
99
96
|
attr_reader :parent
|
100
97
|
# Attribute for field period
|
@@ -118,9 +115,7 @@ module Stripe
|
|
118
115
|
# Always true for a deleted object
|
119
116
|
sig { returns(T::Boolean) }
|
120
117
|
attr_reader :deleted
|
121
|
-
class DeleteParams < Stripe::RequestParams
|
122
|
-
|
123
|
-
end
|
118
|
+
class DeleteParams < Stripe::RequestParams; end
|
124
119
|
class UpdateParams < Stripe::RequestParams
|
125
120
|
class Discount < Stripe::RequestParams
|
126
121
|
# ID of the coupon to create a new discount for.
|
@@ -67,7 +67,7 @@ module Stripe
|
|
67
67
|
sig { returns(T.nilable(ProrationDetails)) }
|
68
68
|
attr_reader :proration_details
|
69
69
|
# The subscription that the subscription item belongs to
|
70
|
-
sig { returns(String) }
|
70
|
+
sig { returns(T.nilable(String)) }
|
71
71
|
attr_reader :subscription
|
72
72
|
# The subscription item that generated this line item
|
73
73
|
sig { returns(String) }
|
@@ -182,7 +182,7 @@ module Stripe
|
|
182
182
|
# String representing the object's type. Objects of the same type share the same value.
|
183
183
|
sig { returns(String) }
|
184
184
|
attr_reader :object
|
185
|
-
# The parent that generated this
|
185
|
+
# The parent that generated this line item.
|
186
186
|
sig { returns(T.nilable(Parent)) }
|
187
187
|
attr_reader :parent
|
188
188
|
# Attribute for field period
|
@@ -3,10 +3,17 @@
|
|
3
3
|
|
4
4
|
# typed: true
|
5
5
|
module Stripe
|
6
|
-
#
|
6
|
+
# Invoice Payments represent payments made against invoices. Invoice Payments can
|
7
|
+
# be accessed in two ways:
|
8
|
+
# 1. By expanding the `payments` field on the [Invoice](https://stripe.com/docs/api#invoice) resource.
|
9
|
+
# 2. By using the Invoice Payment retrieve and list endpoints.
|
10
|
+
#
|
11
|
+
# Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices.
|
12
|
+
# This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and
|
13
|
+
# monitor the allocation details of the payments.
|
7
14
|
class InvoicePayment < APIResource
|
8
15
|
class Payment < Stripe::StripeObject
|
9
|
-
# ID of the successful charge for this payment when `type` is `charge`.
|
16
|
+
# 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.
|
10
17
|
sig { returns(T.any(String, Stripe::Charge)) }
|
11
18
|
attr_reader :charge
|
12
19
|
# 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.
|
@@ -1239,29 +1239,29 @@ module Stripe
|
|
1239
1239
|
sig { params(expand: T.nilable(T::Array[String]), reverse_amount: T.nilable(Integer)).void }
|
1240
1240
|
def initialize(expand: nil, reverse_amount: nil); end
|
1241
1241
|
end
|
1242
|
-
# [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow.
|
1243
|
-
# This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
|
1242
|
+
# [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.
|
1243
|
+
# 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).
|
1244
1244
|
sig {
|
1245
1245
|
params(params: T.any(::Stripe::Issuing::Authorization::ApproveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
|
1246
1246
|
}
|
1247
1247
|
def approve(params = {}, opts = {}); end
|
1248
1248
|
|
1249
|
-
# [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow.
|
1250
|
-
# This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
|
1249
|
+
# [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.
|
1250
|
+
# 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).
|
1251
1251
|
sig {
|
1252
1252
|
params(authorization: String, params: T.any(::Stripe::Issuing::Authorization::ApproveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
|
1253
1253
|
}
|
1254
1254
|
def self.approve(authorization, params = {}, opts = {}); end
|
1255
1255
|
|
1256
|
-
# [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow.
|
1257
|
-
# This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
|
1256
|
+
# [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.
|
1257
|
+
# 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).
|
1258
1258
|
sig {
|
1259
1259
|
params(params: T.any(::Stripe::Issuing::Authorization::DeclineParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
|
1260
1260
|
}
|
1261
1261
|
def decline(params = {}, opts = {}); end
|
1262
1262
|
|
1263
|
-
# [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow.
|
1264
|
-
# This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
|
1263
|
+
# [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.
|
1264
|
+
# 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).
|
1265
1265
|
sig {
|
1266
1266
|
params(authorization: String, params: T.any(::Stripe::Issuing::Authorization::DeclineParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization)
|
1267
1267
|
}
|
@@ -455,7 +455,7 @@ module Stripe
|
|
455
455
|
# Specifies which fields in the response should be expanded.
|
456
456
|
sig { returns(T.nilable(T::Array[String])) }
|
457
457
|
attr_accessor :expand
|
458
|
-
#
|
458
|
+
# The new financial account ID the card will be associated with. This field allows a card to be reassigned to a different financial account.
|
459
459
|
sig { returns(T.nilable(String)) }
|
460
460
|
attr_accessor :financial_account
|
461
461
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
@@ -879,7 +879,7 @@ module Stripe
|
|
879
879
|
}
|
880
880
|
def initialize(expand: nil, metadata: nil); end
|
881
881
|
end
|
882
|
-
# 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://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements.
|
882
|
+
# 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.
|
883
883
|
sig {
|
884
884
|
params(params: T.any(::Stripe::Issuing::Dispute::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute)
|
885
885
|
}
|
@@ -891,13 +891,13 @@ module Stripe
|
|
891
891
|
}
|
892
892
|
def self.list(params = {}, opts = {}); end
|
893
893
|
|
894
|
-
# 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://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence).
|
894
|
+
# 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).
|
895
895
|
sig {
|
896
896
|
params(params: T.any(::Stripe::Issuing::Dispute::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute)
|
897
897
|
}
|
898
898
|
def submit(params = {}, opts = {}); end
|
899
899
|
|
900
|
-
# 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://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence).
|
900
|
+
# 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).
|
901
901
|
sig {
|
902
902
|
params(dispute: String, params: T.any(::Stripe::Issuing::Dispute::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute)
|
903
903
|
}
|
@@ -3,7 +3,8 @@
|
|
3
3
|
|
4
4
|
# typed: true
|
5
5
|
module Stripe
|
6
|
-
# Login Links are single-use URLs
|
6
|
+
# Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard.
|
7
|
+
# 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)
|
7
8
|
class LoginLink < APIResource
|
8
9
|
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
9
10
|
sig { returns(Integer) }
|