stripe 13.4.0.pre.beta.1 → 13.4.0.pre.beta.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -1
- data/OPENAPI_VERSION +1 -1
- data/VERSION +1 -1
- data/lib/stripe/resources/account.rb +23 -745
- data/lib/stripe/resources/account_link.rb +0 -10
- data/lib/stripe/resources/account_notice.rb +0 -22
- data/lib/stripe/resources/account_session.rb +0 -125
- data/lib/stripe/resources/apple_pay_domain.rb +0 -10
- data/lib/stripe/resources/application.rb +0 -3
- data/lib/stripe/resources/application_fee.rb +0 -24
- data/lib/stripe/resources/application_fee_refund.rb +0 -7
- data/lib/stripe/resources/apps/secret.rb +0 -25
- data/lib/stripe/resources/balance.rb +0 -31
- data/lib/stripe/resources/balance_transaction.rb +0 -29
- data/lib/stripe/resources/bank_account.rb +0 -29
- data/lib/stripe/resources/billing/alert.rb +0 -22
- data/lib/stripe/resources/billing/alert_triggered.rb +0 -5
- data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -12
- data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -24
- data/lib/stripe/resources/billing/credit_grant.rb +0 -32
- data/lib/stripe/resources/billing/meter.rb +0 -25
- data/lib/stripe/resources/billing/meter_error_report.rb +0 -11
- data/lib/stripe/resources/billing/meter_event.rb +0 -10
- data/lib/stripe/resources/billing/meter_event_adjustment.rb +0 -8
- data/lib/stripe/resources/billing/meter_event_summary.rb +0 -6
- data/lib/stripe/resources/billing_portal/configuration.rb +0 -77
- data/lib/stripe/resources/billing_portal/session.rb +0 -42
- data/lib/stripe/resources/capability.rb +2 -29
- data/lib/stripe/resources/capital/financing_offer.rb +0 -33
- data/lib/stripe/resources/capital/financing_summary.rb +0 -13
- data/lib/stripe/resources/capital/financing_transaction.rb +0 -24
- data/lib/stripe/resources/card.rb +2 -34
- data/lib/stripe/resources/cash_balance.rb +0 -5
- data/lib/stripe/resources/charge.rb +4 -665
- data/lib/stripe/resources/checkout/session.rb +4 -512
- data/lib/stripe/resources/climate/order.rb +0 -40
- data/lib/stripe/resources/climate/product.rb +0 -13
- data/lib/stripe/resources/climate/supplier.rb +0 -13
- data/lib/stripe/resources/confirmation_token.rb +2 -337
- data/lib/stripe/resources/connect_collection_transfer.rb +0 -5
- data/lib/stripe/resources/country_spec.rb +0 -13
- data/lib/stripe/resources/coupon.rb +0 -39
- data/lib/stripe/resources/credit_note.rb +0 -138
- data/lib/stripe/resources/credit_note_line_item.rb +0 -24
- data/lib/stripe/resources/customer.rb +1 -156
- data/lib/stripe/resources/customer_balance_transaction.rb +0 -12
- data/lib/stripe/resources/customer_cash_balance_transaction.rb +0 -27
- data/lib/stripe/resources/customer_session.rb +0 -24
- data/lib/stripe/resources/discount.rb +0 -12
- data/lib/stripe/resources/dispute.rb +4 -152
- data/lib/stripe/resources/entitlements/active_entitlement.rb +0 -8
- data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +0 -3
- data/lib/stripe/resources/entitlements/feature.rb +0 -17
- data/lib/stripe/resources/ephemeral_key.rb +0 -5
- data/lib/stripe/resources/event.rb +0 -27
- data/lib/stripe/resources/exchange_rate.rb +0 -5
- data/lib/stripe/resources/file.rb +0 -23
- data/lib/stripe/resources/file_link.rb +0 -22
- data/lib/stripe/resources/financial_connections/account.rb +0 -47
- data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -3
- data/lib/stripe/resources/financial_connections/account_owner.rb +0 -7
- data/lib/stripe/resources/financial_connections/account_ownership.rb +0 -3
- data/lib/stripe/resources/financial_connections/institution.rb +0 -13
- data/lib/stripe/resources/financial_connections/session.rb +0 -28
- data/lib/stripe/resources/financial_connections/transaction.rb +0 -21
- data/lib/stripe/resources/forwarding/request.rb +0 -31
- data/lib/stripe/resources/funding_instructions.rb +0 -107
- data/lib/stripe/resources/gift_cards/card.rb +0 -28
- data/lib/stripe/resources/gift_cards/transaction.rb +0 -32
- data/lib/stripe/resources/identity/verification_report.rb +0 -69
- data/lib/stripe/resources/identity/verification_session.rb +0 -69
- data/lib/stripe/resources/invoice.rb +6 -1276
- data/lib/stripe/resources/invoice_item.rb +0 -91
- data/lib/stripe/resources/invoice_line_item.rb +0 -76
- data/lib/stripe/resources/invoice_payment.rb +0 -16
- data/lib/stripe/resources/invoice_rendering_template.rb +0 -12
- data/lib/stripe/resources/issuing/authorization.rb +0 -199
- data/lib/stripe/resources/issuing/card.rb +0 -128
- data/lib/stripe/resources/issuing/cardholder.rb +0 -110
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -82
- data/lib/stripe/resources/issuing/dispute.rb +0 -151
- data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -14
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -14
- data/lib/stripe/resources/issuing/personalization_design.rb +0 -48
- data/lib/stripe/resources/issuing/physical_bundle.rb +0 -13
- data/lib/stripe/resources/issuing/settlement.rb +0 -16
- data/lib/stripe/resources/issuing/token.rb +0 -46
- data/lib/stripe/resources/issuing/transaction.rb +0 -171
- data/lib/stripe/resources/line_item.rb +0 -23
- data/lib/stripe/resources/login_link.rb +0 -2
- data/lib/stripe/resources/mandate.rb +0 -45
- data/lib/stripe/resources/margin.rb +0 -19
- data/lib/stripe/resources/order.rb +3 -391
- data/lib/stripe/resources/payment_attempt_record.rb +0 -42
- data/lib/stripe/resources/payment_intent.rb +2 -1768
- data/lib/stripe/resources/payment_link.rb +15 -213
- data/lib/stripe/resources/payment_method.rb +2 -345
- data/lib/stripe/resources/payment_method_configuration.rb +0 -293
- data/lib/stripe/resources/payment_method_domain.rb +0 -23
- data/lib/stripe/resources/payment_record.rb +0 -109
- data/lib/stripe/resources/payout.rb +0 -49
- data/lib/stripe/resources/person.rb +2 -92
- data/lib/stripe/resources/plan.rb +0 -69
- data/lib/stripe/resources/price.rb +0 -133
- data/lib/stripe/resources/product.rb +0 -100
- data/lib/stripe/resources/product_feature.rb +0 -4
- data/lib/stripe/resources/promotion_code.rb +0 -40
- data/lib/stripe/resources/quote.rb +0 -458
- data/lib/stripe/resources/quote_line.rb +0 -66
- data/lib/stripe/resources/quote_preview_invoice.rb +3 -184
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -101
- data/lib/stripe/resources/radar/early_fraud_warning.rb +0 -16
- data/lib/stripe/resources/radar/value_list.rb +0 -26
- data/lib/stripe/resources/radar/value_list_item.rb +0 -18
- data/lib/stripe/resources/refund.rb +0 -92
- data/lib/stripe/resources/reporting/report_run.rb +0 -32
- data/lib/stripe/resources/reporting/report_type.rb +0 -8
- data/lib/stripe/resources/reserve_transaction.rb +0 -4
- data/lib/stripe/resources/reversal.rb +0 -9
- data/lib/stripe/resources/review.rb +0 -27
- data/lib/stripe/resources/setup_attempt.rb +2 -103
- data/lib/stripe/resources/setup_intent.rb +2 -539
- data/lib/stripe/resources/shipping_rate.rb +0 -44
- data/lib/stripe/resources/sigma/scheduled_query_run.rb +0 -13
- data/lib/stripe/resources/source.rb +6 -338
- data/lib/stripe/resources/source_mandate_notification.rb +0 -13
- data/lib/stripe/resources/source_transaction.rb +0 -29
- data/lib/stripe/resources/subscription.rb +0 -338
- data/lib/stripe/resources/subscription_item.rb +0 -69
- data/lib/stripe/resources/subscription_schedule.rb +0 -388
- data/lib/stripe/resources/tax/association.rb +0 -11
- data/lib/stripe/resources/tax/calculation.rb +2 -89
- data/lib/stripe/resources/tax/calculation_line_item.rb +0 -20
- data/lib/stripe/resources/tax/form.rb +2 -35
- data/lib/stripe/resources/tax/registration.rb +421 -213
- data/lib/stripe/resources/tax/settings.rb +0 -20
- data/lib/stripe/resources/tax/transaction.rb +1 -66
- data/lib/stripe/resources/tax/transaction_line_item.rb +0 -12
- data/lib/stripe/resources/tax_code.rb +0 -6
- data/lib/stripe/resources/tax_deducted_at_source.rb +0 -4
- data/lib/stripe/resources/tax_id.rb +2 -28
- data/lib/stripe/resources/tax_rate.rb +0 -45
- data/lib/stripe/resources/terminal/configuration.rb +0 -164
- data/lib/stripe/resources/terminal/connection_token.rb +0 -3
- data/lib/stripe/resources/terminal/location.rb +0 -33
- data/lib/stripe/resources/terminal/reader.rb +0 -129
- data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -5
- data/lib/stripe/resources/test_helpers/test_clock.rb +0 -15
- data/lib/stripe/resources/token.rb +4 -192
- data/lib/stripe/resources/topup.rb +0 -36
- data/lib/stripe/resources/transfer.rb +0 -35
- data/lib/stripe/resources/treasury/credit_reversal.rb +0 -21
- data/lib/stripe/resources/treasury/debit_reversal.rb +0 -23
- data/lib/stripe/resources/treasury/financial_account.rb +77 -71
- data/lib/stripe/resources/treasury/financial_account_features.rb +0 -46
- data/lib/stripe/resources/treasury/inbound_transfer.rb +0 -50
- data/lib/stripe/resources/treasury/outbound_payment.rb +0 -92
- data/lib/stripe/resources/treasury/outbound_transfer.rb +25 -66
- data/lib/stripe/resources/treasury/received_credit.rb +6 -58
- data/lib/stripe/resources/treasury/received_debit.rb +0 -54
- data/lib/stripe/resources/treasury/transaction.rb +0 -39
- data/lib/stripe/resources/treasury/transaction_entry.rb +0 -36
- data/lib/stripe/resources/usage_record.rb +0 -5
- data/lib/stripe/resources/usage_record_summary.rb +0 -7
- data/lib/stripe/resources/v2/billing/meter_event.rb +0 -6
- data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +0 -7
- data/lib/stripe/resources/v2/billing/meter_event_session.rb +0 -5
- data/lib/stripe/resources/v2/event.rb +0 -8
- data/lib/stripe/resources/v2/event_destination.rb +0 -19
- data/lib/stripe/resources/webhook_endpoint.rb +0 -26
- data/lib/stripe/services/account_capability_service.rb +0 -1
- data/lib/stripe/services/account_external_account_service.rb +0 -43
- data/lib/stripe/services/account_link_service.rb +0 -7
- data/lib/stripe/services/account_notice_service.rb +0 -9
- data/lib/stripe/services/account_person_service.rb +0 -139
- data/lib/stripe/services/account_service.rb +8 -519
- data/lib/stripe/services/account_session_service.rb +0 -76
- data/lib/stripe/services/apple_pay_domain_service.rb +0 -5
- data/lib/stripe/services/application_fee_refund_service.rb +0 -6
- data/lib/stripe/services/application_fee_service.rb +0 -8
- data/lib/stripe/services/apps/secret_service.rb +0 -16
- data/lib/stripe/services/balance_transaction_service.rb +0 -11
- data/lib/stripe/services/billing/alert_service.rb +0 -12
- data/lib/stripe/services/billing/credit_balance_summary_service.rb +0 -4
- data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -5
- data/lib/stripe/services/billing/credit_grant_service.rb +0 -16
- data/lib/stripe/services/billing/meter_event_adjustment_service.rb +0 -3
- data/lib/stripe/services/billing/meter_event_service.rb +0 -4
- data/lib/stripe/services/billing/meter_event_summary_service.rb +0 -7
- data/lib/stripe/services/billing/meter_service.rb +0 -12
- data/lib/stripe/services/billing_portal/configuration_service.rb +0 -48
- data/lib/stripe/services/billing_portal/session_service.rb +0 -19
- data/lib/stripe/services/capital/financing_offer_service.rb +0 -9
- data/lib/stripe/services/capital/financing_transaction_service.rb +0 -7
- data/lib/stripe/services/charge_service.rb +0 -274
- data/lib/stripe/services/checkout/session_line_item_service.rb +0 -3
- data/lib/stripe/services/checkout/session_service.rb +2 -273
- data/lib/stripe/services/climate/order_service.rb +0 -11
- data/lib/stripe/services/climate/product_service.rb +0 -3
- data/lib/stripe/services/climate/supplier_service.rb +0 -3
- data/lib/stripe/services/country_spec_service.rb +0 -3
- data/lib/stripe/services/coupon_service.rb +0 -22
- data/lib/stripe/services/credit_note_line_item_service.rb +0 -3
- data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -28
- data/lib/stripe/services/credit_note_service.rb +0 -61
- data/lib/stripe/services/customer_balance_transaction_service.rb +0 -9
- data/lib/stripe/services/customer_cash_balance_service.rb +0 -1
- data/lib/stripe/services/customer_cash_balance_transaction_service.rb +0 -3
- data/lib/stripe/services/customer_funding_instructions_service.rb +0 -5
- data/lib/stripe/services/customer_payment_method_service.rb +0 -5
- data/lib/stripe/services/customer_payment_source_service.rb +0 -29
- data/lib/stripe/services/customer_service.rb +1 -92
- data/lib/stripe/services/customer_session_service.rb +0 -10
- data/lib/stripe/services/customer_tax_id_service.rb +1 -6
- data/lib/stripe/services/dispute_service.rb +2 -67
- data/lib/stripe/services/entitlements/active_entitlement_service.rb +0 -4
- data/lib/stripe/services/entitlements/feature_service.rb +0 -11
- data/lib/stripe/services/ephemeral_key_service.rb +0 -4
- data/lib/stripe/services/event_service.rb +0 -10
- data/lib/stripe/services/exchange_rate_service.rb +0 -3
- data/lib/stripe/services/file_link_service.rb +0 -14
- data/lib/stripe/services/file_service.rb +0 -13
- data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -3
- data/lib/stripe/services/financial_connections/account_owner_service.rb +0 -4
- data/lib/stripe/services/financial_connections/account_service.rb +0 -9
- data/lib/stripe/services/financial_connections/institution_service.rb +0 -3
- data/lib/stripe/services/financial_connections/session_service.rb +0 -11
- data/lib/stripe/services/financial_connections/transaction_service.rb +0 -9
- data/lib/stripe/services/forwarding/request_service.rb +0 -14
- data/lib/stripe/services/gift_cards/card_service.rb +0 -13
- data/lib/stripe/services/gift_cards/transaction_service.rb +0 -16
- data/lib/stripe/services/identity/verification_report_service.rb +0 -10
- data/lib/stripe/services/identity/verification_session_service.rb +0 -30
- data/lib/stripe/services/invoice_item_service.rb +0 -66
- data/lib/stripe/services/invoice_line_item_service.rb +0 -40
- data/lib/stripe/services/invoice_payment_service.rb +0 -3
- data/lib/stripe/services/invoice_rendering_template_service.rb +0 -5
- data/lib/stripe/services/invoice_service.rb +2 -810
- data/lib/stripe/services/invoice_upcoming_lines_service.rb +1 -279
- data/lib/stripe/services/issuing/authorization_service.rb +0 -14
- data/lib/stripe/services/issuing/card_service.rb +0 -70
- data/lib/stripe/services/issuing/cardholder_service.rb +0 -73
- data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -56
- data/lib/stripe/services/issuing/dispute_service.rb +0 -98
- data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -4
- data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -7
- data/lib/stripe/services/issuing/personalization_design_service.rb +0 -29
- data/lib/stripe/services/issuing/physical_bundle_service.rb +0 -5
- data/lib/stripe/services/issuing/token_service.rb +0 -10
- data/lib/stripe/services/issuing/transaction_service.rb +0 -12
- data/lib/stripe/services/margin_service.rb +0 -11
- data/lib/stripe/services/order_line_item_service.rb +0 -3
- data/lib/stripe/services/order_service.rb +2 -266
- data/lib/stripe/services/payment_attempt_record_service.rb +0 -1
- data/lib/stripe/services/payment_intent_service.rb +0 -1309
- data/lib/stripe/services/payment_link_line_item_service.rb +0 -3
- data/lib/stripe/services/payment_link_service.rb +15 -135
- data/lib/stripe/services/payment_method_configuration_service.rb +0 -102
- data/lib/stripe/services/payment_method_domain_service.rb +0 -8
- data/lib/stripe/services/payment_method_service.rb +0 -113
- data/lib/stripe/services/payment_record_service.rb +0 -68
- data/lib/stripe/services/payout_service.rb +0 -23
- data/lib/stripe/services/plan_service.rb +0 -43
- data/lib/stripe/services/price_service.rb +0 -87
- data/lib/stripe/services/product_feature_service.rb +0 -4
- data/lib/stripe/services/product_service.rb +0 -74
- data/lib/stripe/services/promotion_code_service.rb +0 -25
- data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +0 -3
- data/lib/stripe/services/quote_line_item_service.rb +0 -3
- data/lib/stripe/services/quote_line_service.rb +0 -3
- data/lib/stripe/services/quote_preview_invoice_service.rb +0 -3
- data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -3
- data/lib/stripe/services/quote_service.rb +0 -309
- data/lib/stripe/services/radar/early_fraud_warning_service.rb +0 -9
- data/lib/stripe/services/radar/value_list_item_service.rb +0 -11
- data/lib/stripe/services/radar/value_list_service.rb +0 -16
- data/lib/stripe/services/refund_service.rb +0 -21
- data/lib/stripe/services/reporting/report_run_service.rb +0 -16
- data/lib/stripe/services/review_service.rb +0 -7
- data/lib/stripe/services/setup_attempt_service.rb +0 -8
- data/lib/stripe/services/setup_intent_service.rb +0 -447
- data/lib/stripe/services/shipping_rate_service.rb +0 -27
- data/lib/stripe/services/sigma/scheduled_query_run_service.rb +0 -3
- data/lib/stripe/services/source_service.rb +0 -92
- data/lib/stripe/services/source_transaction_service.rb +0 -3
- data/lib/stripe/services/subscription_item_service.rb +0 -56
- data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -3
- data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -3
- data/lib/stripe/services/subscription_schedule_service.rb +0 -290
- data/lib/stripe/services/subscription_service.rb +0 -245
- data/lib/stripe/services/tax/association_service.rb +0 -1
- data/lib/stripe/services/tax/calculation_line_item_service.rb +0 -3
- data/lib/stripe/services/tax/calculation_service.rb +1 -31
- data/lib/stripe/services/tax/form_service.rb +0 -7
- data/lib/stripe/services/tax/registration_service.rb +274 -108
- data/lib/stripe/services/tax/settings_service.rb +0 -8
- data/lib/stripe/services/tax/transaction_line_item_service.rb +0 -3
- data/lib/stripe/services/tax/transaction_service.rb +0 -17
- data/lib/stripe/services/tax_code_service.rb +0 -3
- data/lib/stripe/services/tax_id_service.rb +1 -12
- data/lib/stripe/services/tax_rate_service.rb +0 -27
- data/lib/stripe/services/terminal/configuration_service.rb +0 -108
- data/lib/stripe/services/terminal/connection_token_service.rb +0 -1
- data/lib/stripe/services/terminal/location_service.rb +0 -21
- data/lib/stripe/services/terminal/reader_service.rb +0 -53
- data/lib/stripe/services/test_helpers/confirmation_token_service.rb +0 -89
- data/lib/stripe/services/test_helpers/customer_service.rb +0 -3
- data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +0 -99
- data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +0 -2
- data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +0 -91
- data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -4
- data/lib/stripe/services/test_helpers/test_clock_service.rb +0 -6
- data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +0 -1
- data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +0 -6
- data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +0 -6
- data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +0 -11
- data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +0 -11
- data/lib/stripe/services/token_service.rb +4 -184
- data/lib/stripe/services/topup_service.rb +0 -21
- data/lib/stripe/services/transfer_reversal_service.rb +0 -8
- data/lib/stripe/services/transfer_service.rb +0 -19
- data/lib/stripe/services/treasury/credit_reversal_service.rb +0 -8
- data/lib/stripe/services/treasury/debit_reversal_service.rb +0 -9
- data/lib/stripe/services/treasury/financial_account_features_service.rb +0 -10
- data/lib/stripe/services/treasury/financial_account_service.rb +64 -36
- data/lib/stripe/services/treasury/inbound_transfer_service.rb +0 -12
- data/lib/stripe/services/treasury/outbound_payment_service.rb +0 -38
- data/lib/stripe/services/treasury/outbound_transfer_service.rb +16 -15
- data/lib/stripe/services/treasury/received_credit_service.rb +0 -6
- data/lib/stripe/services/treasury/received_debit_service.rb +0 -5
- data/lib/stripe/services/treasury/transaction_entry_service.rb +0 -14
- data/lib/stripe/services/treasury/transaction_service.rb +0 -14
- data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +0 -2
- data/lib/stripe/services/v2/billing/meter_event_service.rb +0 -3
- data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +0 -3
- data/lib/stripe/services/v2/core/event_destination_service.rb +0 -18
- data/lib/stripe/services/v2/core/event_service.rb +0 -2
- data/lib/stripe/services/webhook_endpoint_service.rb +0 -14
- data/lib/stripe/stripe_client.rb +1 -1
- data/lib/stripe/stripe_object.rb +3 -3
- data/lib/stripe/util.rb +1 -1
- data/lib/stripe/version.rb +1 -1
- data/rbi/stripe/resources/account.rbi +29 -1001
- data/rbi/stripe/resources/account_link.rbi +0 -13
- data/rbi/stripe/resources/account_notice.rbi +0 -27
- data/rbi/stripe/resources/account_session.rbi +0 -166
- data/rbi/stripe/resources/apple_pay_domain.rbi +0 -14
- data/rbi/stripe/resources/application.rbi +0 -3
- data/rbi/stripe/resources/application_fee.rbi +0 -28
- data/rbi/stripe/resources/application_fee_refund.rbi +0 -7
- data/rbi/stripe/resources/apps/secret.rbi +0 -34
- data/rbi/stripe/resources/balance.rbi +0 -33
- data/rbi/stripe/resources/balance_transaction.rbi +0 -33
- data/rbi/stripe/resources/bank_account.rbi +0 -29
- data/rbi/stripe/resources/billing/alert.rbi +0 -31
- data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -5
- data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -16
- data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -27
- data/rbi/stripe/resources/billing/credit_grant.rbi +0 -43
- data/rbi/stripe/resources/billing/meter.rbi +0 -35
- data/rbi/stripe/resources/billing/meter_error_report.rbi +0 -11
- data/rbi/stripe/resources/billing/meter_event.rbi +0 -12
- data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -11
- data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -6
- data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -106
- data/rbi/stripe/resources/billing_portal/session.rbi +0 -55
- data/rbi/stripe/resources/capability.rbi +2 -29
- data/rbi/stripe/resources/capital/financing_offer.rbi +0 -38
- data/rbi/stripe/resources/capital/financing_summary.rbi +0 -15
- data/rbi/stripe/resources/capital/financing_transaction.rbi +0 -27
- data/rbi/stripe/resources/card.rbi +3 -34
- data/rbi/stripe/resources/cash_balance.rbi +0 -5
- data/rbi/stripe/resources/charge.rbi +6 -738
- data/rbi/stripe/resources/checkout/session.rbi +4 -636
- data/rbi/stripe/resources/climate/order.rbi +0 -48
- data/rbi/stripe/resources/climate/product.rbi +0 -16
- data/rbi/stripe/resources/climate/supplier.rbi +0 -16
- data/rbi/stripe/resources/confirmation_token.rbi +3 -364
- data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -5
- data/rbi/stripe/resources/country_spec.rbi +0 -16
- data/rbi/stripe/resources/coupon.rbi +0 -48
- data/rbi/stripe/resources/credit_note.rbi +0 -159
- data/rbi/stripe/resources/credit_note_line_item.rbi +0 -24
- data/rbi/stripe/resources/customer.rbi +1 -188
- data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -12
- data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -27
- data/rbi/stripe/resources/customer_session.rbi +0 -31
- data/rbi/stripe/resources/discount.rbi +0 -12
- data/rbi/stripe/resources/dispute.rbi +4 -166
- data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -11
- data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -3
- data/rbi/stripe/resources/entitlements/feature.rbi +0 -22
- data/rbi/stripe/resources/ephemeral_key.rbi +0 -7
- data/rbi/stripe/resources/event.rbi +0 -31
- data/rbi/stripe/resources/exchange_rate.rbi +0 -8
- data/rbi/stripe/resources/file.rbi +0 -29
- data/rbi/stripe/resources/file_link.rbi +0 -28
- data/rbi/stripe/resources/financial_connections/account.rbi +0 -56
- data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +0 -3
- data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -7
- data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -3
- data/rbi/stripe/resources/financial_connections/institution.rbi +0 -16
- data/rbi/stripe/resources/financial_connections/session.rbi +0 -35
- data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -26
- data/rbi/stripe/resources/forwarding/request.rbi +0 -38
- data/rbi/stripe/resources/funding_instructions.rbi +0 -107
- data/rbi/stripe/resources/gift_cards/card.rbi +0 -36
- data/rbi/stripe/resources/gift_cards/transaction.rbi +0 -41
- data/rbi/stripe/resources/identity/verification_report.rbi +0 -73
- data/rbi/stripe/resources/identity/verification_session.rbi +0 -83
- data/rbi/stripe/resources/invoice.rbi +7 -1663
- data/rbi/stripe/resources/invoice_item.rbi +0 -107
- data/rbi/stripe/resources/invoice_line_item.rbi +0 -86
- data/rbi/stripe/resources/invoice_payment.rbi +0 -16
- data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -17
- data/rbi/stripe/resources/issuing/authorization.rbi +0 -245
- data/rbi/stripe/resources/issuing/card.rbi +0 -153
- data/rbi/stripe/resources/issuing/cardholder.rbi +0 -138
- data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +0 -109
- data/rbi/stripe/resources/issuing/dispute.rbi +0 -177
- data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +0 -17
- data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +0 -18
- data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -62
- data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -16
- data/rbi/stripe/resources/issuing/settlement.rbi +0 -16
- data/rbi/stripe/resources/issuing/token.rbi +0 -51
- data/rbi/stripe/resources/issuing/transaction.rbi +0 -205
- data/rbi/stripe/resources/line_item.rbi +0 -23
- data/rbi/stripe/resources/login_link.rbi +0 -2
- data/rbi/stripe/resources/mandate.rbi +0 -47
- data/rbi/stripe/resources/margin.rbi +0 -24
- data/rbi/stripe/resources/order.rbi +3 -492
- data/rbi/stripe/resources/payment_attempt_record.rbi +0 -45
- data/rbi/stripe/resources/payment_intent.rbi +3 -2224
- data/rbi/stripe/resources/payment_link.rbi +14 -291
- data/rbi/stripe/resources/payment_method.rbi +3 -382
- data/rbi/stripe/resources/payment_method_configuration.rbi +0 -486
- data/rbi/stripe/resources/payment_method_domain.rbi +0 -29
- data/rbi/stripe/resources/payment_record.rbi +0 -134
- data/rbi/stripe/resources/payout.rbi +0 -58
- data/rbi/stripe/resources/person.rbi +2 -92
- data/rbi/stripe/resources/plan.rbi +0 -78
- data/rbi/stripe/resources/price.rbi +0 -153
- data/rbi/stripe/resources/product.rbi +0 -120
- data/rbi/stripe/resources/product_feature.rbi +0 -4
- data/rbi/stripe/resources/promotion_code.rbi +0 -50
- data/rbi/stripe/resources/quote.rbi +0 -593
- data/rbi/stripe/resources/quote_line.rbi +0 -66
- data/rbi/stripe/resources/quote_preview_invoice.rbi +4 -184
- data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +0 -101
- data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -20
- data/rbi/stripe/resources/radar/value_list.rbi +0 -32
- data/rbi/stripe/resources/radar/value_list_item.rbi +0 -23
- data/rbi/stripe/resources/refund.rbi +0 -100
- data/rbi/stripe/resources/reporting/report_run.rbi +0 -38
- data/rbi/stripe/resources/reporting/report_type.rbi +0 -11
- data/rbi/stripe/resources/reserve_transaction.rbi +0 -4
- data/rbi/stripe/resources/reversal.rbi +0 -9
- data/rbi/stripe/resources/review.rbi +0 -32
- data/rbi/stripe/resources/setup_attempt.rbi +3 -106
- data/rbi/stripe/resources/setup_intent.rbi +3 -688
- data/rbi/stripe/resources/shipping_rate.rbi +0 -57
- data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -16
- data/rbi/stripe/resources/source.rbi +9 -365
- data/rbi/stripe/resources/source_mandate_notification.rbi +0 -13
- data/rbi/stripe/resources/source_transaction.rbi +0 -29
- data/rbi/stripe/resources/subscription.rbi +0 -431
- data/rbi/stripe/resources/subscription_item.rbi +0 -88
- data/rbi/stripe/resources/subscription_schedule.rbi +0 -504
- data/rbi/stripe/resources/tax/association.rbi +0 -13
- data/rbi/stripe/resources/tax/calculation.rbi +2 -100
- data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -20
- data/rbi/stripe/resources/tax/form.rbi +2 -40
- data/rbi/stripe/resources/tax/registration.rbi +401 -317
- data/rbi/stripe/resources/tax/settings.rbi +0 -26
- data/rbi/stripe/resources/tax/transaction.rbi +1 -73
- data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -12
- data/rbi/stripe/resources/tax_code.rbi +0 -9
- data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -4
- data/rbi/stripe/resources/tax_id.rbi +2 -34
- data/rbi/stripe/resources/tax_rate.rbi +0 -51
- data/rbi/stripe/resources/terminal/configuration.rbi +0 -211
- data/rbi/stripe/resources/terminal/connection_token.rbi +0 -5
- data/rbi/stripe/resources/terminal/location.rbi +0 -40
- data/rbi/stripe/resources/terminal/reader.rbi +0 -158
- data/rbi/stripe/resources/terminal/reader_collected_data.rbi +0 -7
- data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -20
- data/rbi/stripe/resources/token.rbi +5 -235
- data/rbi/stripe/resources/topup.rbi +0 -44
- data/rbi/stripe/resources/transfer.rbi +0 -41
- data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -25
- data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -27
- data/rbi/stripe/resources/treasury/financial_account.rbi +70 -124
- data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -46
- data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -59
- data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -113
- data/rbi/stripe/resources/treasury/outbound_transfer.rbi +28 -84
- data/rbi/stripe/resources/treasury/received_credit.rbi +7 -67
- data/rbi/stripe/resources/treasury/received_debit.rbi +0 -62
- data/rbi/stripe/resources/treasury/transaction.rbi +0 -45
- data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -41
- data/rbi/stripe/resources/usage_record.rbi +0 -5
- data/rbi/stripe/resources/usage_record_summary.rbi +0 -7
- data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -6
- data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -7
- data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -5
- data/rbi/stripe/resources/v2/event.rbi +0 -8
- data/rbi/stripe/resources/v2/event_destination.rbi +0 -19
- data/rbi/stripe/resources/webhook_endpoint.rbi +0 -31
- data/rbi/stripe/services/account_capability_service.rbi +0 -4
- data/rbi/stripe/services/account_external_account_service.rbi +0 -52
- data/rbi/stripe/services/account_link_service.rbi +0 -9
- data/rbi/stripe/services/account_login_link_service.rbi +0 -1
- data/rbi/stripe/services/account_notice_service.rbi +0 -13
- data/rbi/stripe/services/account_person_service.rbi +0 -174
- data/rbi/stripe/services/account_service.rbi +10 -773
- data/rbi/stripe/services/account_session_service.rbi +0 -116
- data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -8
- data/rbi/stripe/services/application_fee_refund_service.rbi +0 -10
- data/rbi/stripe/services/application_fee_service.rbi +0 -11
- data/rbi/stripe/services/apps/secret_service.rbi +0 -24
- data/rbi/stripe/services/balance_service.rbi +0 -1
- data/rbi/stripe/services/balance_transaction_service.rbi +0 -14
- data/rbi/stripe/services/billing/alert_service.rbi +0 -20
- data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -7
- data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -7
- data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -26
- data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -5
- data/rbi/stripe/services/billing/meter_event_service.rbi +0 -5
- data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -8
- data/rbi/stripe/services/billing/meter_service.rbi +0 -21
- data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -76
- data/rbi/stripe/services/billing_portal/session_service.rbi +0 -31
- data/rbi/stripe/services/capital/financing_offer_service.rbi +0 -13
- data/rbi/stripe/services/capital/financing_summary_service.rbi +0 -1
- data/rbi/stripe/services/capital/financing_transaction_service.rbi +0 -9
- data/rbi/stripe/services/charge_service.rbi +0 -346
- data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -4
- data/rbi/stripe/services/checkout/session_service.rbi +2 -395
- data/rbi/stripe/services/climate/order_service.rbi +0 -18
- data/rbi/stripe/services/climate/product_service.rbi +0 -5
- data/rbi/stripe/services/climate/supplier_service.rbi +0 -5
- data/rbi/stripe/services/confirmation_token_service.rbi +0 -1
- data/rbi/stripe/services/country_spec_service.rbi +0 -5
- data/rbi/stripe/services/coupon_service.rbi +0 -30
- data/rbi/stripe/services/credit_note_line_item_service.rbi +0 -4
- data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -33
- data/rbi/stripe/services/credit_note_service.rbi +0 -76
- data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -13
- data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -4
- data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -5
- data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -8
- data/rbi/stripe/services/customer_payment_method_service.rbi +0 -7
- data/rbi/stripe/services/customer_payment_source_service.rbi +0 -37
- data/rbi/stripe/services/customer_service.rbi +1 -117
- data/rbi/stripe/services/customer_session_service.rbi +0 -16
- data/rbi/stripe/services/customer_tax_id_service.rbi +1 -9
- data/rbi/stripe/services/dispute_service.rbi +2 -80
- data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -6
- data/rbi/stripe/services/entitlements/feature_service.rbi +0 -15
- data/rbi/stripe/services/ephemeral_key_service.rbi +0 -6
- data/rbi/stripe/services/event_service.rbi +0 -13
- data/rbi/stripe/services/exchange_rate_service.rbi +0 -5
- data/rbi/stripe/services/file_link_service.rbi +0 -19
- data/rbi/stripe/services/file_service.rbi +0 -18
- data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +0 -4
- data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -5
- data/rbi/stripe/services/financial_connections/account_service.rbi +0 -16
- data/rbi/stripe/services/financial_connections/institution_service.rbi +0 -5
- data/rbi/stripe/services/financial_connections/session_service.rbi +0 -17
- data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -13
- data/rbi/stripe/services/forwarding/request_service.rbi +0 -20
- data/rbi/stripe/services/gift_cards/card_service.rbi +0 -20
- data/rbi/stripe/services/gift_cards/transaction_service.rbi +0 -24
- data/rbi/stripe/services/identity/verification_report_service.rbi +0 -13
- data/rbi/stripe/services/identity/verification_session_service.rbi +0 -43
- data/rbi/stripe/services/invoice_item_service.rbi +0 -81
- data/rbi/stripe/services/invoice_line_item_service.rbi +0 -50
- data/rbi/stripe/services/invoice_payment_service.rbi +0 -5
- data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -9
- data/rbi/stripe/services/invoice_service.rbi +2 -1100
- data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +1 -375
- data/rbi/stripe/services/issuing/authorization_service.rbi +0 -20
- data/rbi/stripe/services/issuing/card_service.rbi +0 -89
- data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -100
- data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +0 -82
- data/rbi/stripe/services/issuing/dispute_service.rbi +0 -123
- data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +0 -6
- data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +0 -10
- data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -38
- data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -7
- data/rbi/stripe/services/issuing/token_service.rbi +0 -14
- data/rbi/stripe/services/issuing/transaction_service.rbi +0 -16
- data/rbi/stripe/services/mandate_service.rbi +0 -1
- data/rbi/stripe/services/margin_service.rbi +0 -15
- data/rbi/stripe/services/order_line_item_service.rbi +0 -4
- data/rbi/stripe/services/order_service.rbi +2 -365
- data/rbi/stripe/services/payment_attempt_record_service.rbi +0 -3
- data/rbi/stripe/services/payment_intent_service.rbi +0 -1764
- data/rbi/stripe/services/payment_link_line_item_service.rbi +0 -4
- data/rbi/stripe/services/payment_link_service.rbi +14 -211
- data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -294
- data/rbi/stripe/services/payment_method_domain_service.rbi +0 -13
- data/rbi/stripe/services/payment_method_service.rbi +0 -149
- data/rbi/stripe/services/payment_record_service.rbi +0 -92
- data/rbi/stripe/services/payout_service.rbi +0 -31
- data/rbi/stripe/services/plan_service.rbi +0 -51
- data/rbi/stripe/services/price_service.rbi +0 -106
- data/rbi/stripe/services/product_feature_service.rbi +0 -7
- data/rbi/stripe/services/product_service.rbi +0 -93
- data/rbi/stripe/services/promotion_code_service.rbi +0 -34
- data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -4
- data/rbi/stripe/services/quote_line_item_service.rbi +0 -4
- data/rbi/stripe/services/quote_line_service.rbi +0 -4
- data/rbi/stripe/services/quote_preview_invoice_service.rbi +0 -4
- data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +0 -4
- data/rbi/stripe/services/quote_service.rbi +0 -440
- data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -12
- data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -15
- data/rbi/stripe/services/radar/value_list_service.rbi +0 -21
- data/rbi/stripe/services/refund_service.rbi +0 -27
- data/rbi/stripe/services/reporting/report_run_service.rbi +0 -21
- data/rbi/stripe/services/reporting/report_type_service.rbi +0 -2
- data/rbi/stripe/services/review_service.rbi +0 -11
- data/rbi/stripe/services/setup_attempt_service.rbi +0 -10
- data/rbi/stripe/services/setup_intent_service.rbi +0 -595
- data/rbi/stripe/services/shipping_rate_service.rbi +0 -39
- data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -5
- data/rbi/stripe/services/source_service.rbi +0 -119
- data/rbi/stripe/services/source_transaction_service.rbi +0 -4
- data/rbi/stripe/services/subscription_item_service.rbi +0 -74
- data/rbi/stripe/services/subscription_item_usage_record_service.rbi +0 -4
- data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +0 -4
- data/rbi/stripe/services/subscription_schedule_service.rbi +0 -405
- data/rbi/stripe/services/subscription_service.rbi +0 -337
- data/rbi/stripe/services/tax/association_service.rbi +0 -2
- data/rbi/stripe/services/tax/calculation_line_item_service.rbi +0 -4
- data/rbi/stripe/services/tax/calculation_service.rbi +1 -40
- data/rbi/stripe/services/tax/form_service.rbi +0 -11
- data/rbi/stripe/services/tax/registration_service.rbi +233 -211
- data/rbi/stripe/services/tax/settings_service.rbi +0 -13
- data/rbi/stripe/services/tax/transaction_line_item_service.rbi +0 -4
- data/rbi/stripe/services/tax/transaction_service.rbi +0 -22
- data/rbi/stripe/services/tax_code_service.rbi +0 -5
- data/rbi/stripe/services/tax_id_service.rbi +1 -17
- data/rbi/stripe/services/tax_rate_service.rbi +0 -32
- data/rbi/stripe/services/terminal/configuration_service.rbi +0 -154
- data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -2
- data/rbi/stripe/services/terminal/location_service.rbi +0 -27
- data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +0 -1
- data/rbi/stripe/services/terminal/reader_service.rbi +0 -78
- data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -114
- data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -4
- data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -138
- data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -5
- data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -6
- data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -120
- data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -1
- data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -7
- data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -10
- data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -5
- data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -14
- data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -14
- data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -16
- data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -16
- data/rbi/stripe/services/token_service.rbi +5 -226
- data/rbi/stripe/services/topup_service.rbi +0 -28
- data/rbi/stripe/services/transfer_reversal_service.rbi +0 -12
- data/rbi/stripe/services/transfer_service.rbi +0 -24
- data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -11
- data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -12
- data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -25
- data/rbi/stripe/services/treasury/financial_account_service.rbi +62 -73
- data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -16
- data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -50
- data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +17 -24
- data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -9
- data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -7
- data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -18
- data/rbi/stripe/services/treasury/transaction_service.rbi +0 -19
- data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -4
- data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -4
- data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -5
- data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -25
- data/rbi/stripe/services/v2/core/event_service.rbi +0 -3
- data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -18
- metadata +2 -2
@@ -29,17 +29,14 @@ module Stripe
|
|
29
29
|
# Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
|
30
30
|
sig { returns(T::Boolean) }
|
31
31
|
attr_reader :allow_promotion_codes
|
32
|
-
|
33
32
|
# If `true`, a recovery url will be generated to recover this Checkout Session if it
|
34
33
|
# expires before a transaction is completed. It will be attached to the
|
35
34
|
# Checkout Session object upon expiration.
|
36
35
|
sig { returns(T::Boolean) }
|
37
36
|
attr_reader :enabled
|
38
|
-
|
39
37
|
# The timestamp at which the recovery URL will expire.
|
40
38
|
sig { returns(T.nilable(Integer)) }
|
41
39
|
attr_reader :expires_at
|
42
|
-
|
43
40
|
# URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session
|
44
41
|
sig { returns(T.nilable(String)) }
|
45
42
|
attr_reader :url
|
@@ -53,7 +50,6 @@ module Stripe
|
|
53
50
|
# The connected account being referenced when `type` is `account`.
|
54
51
|
sig { returns(T.any(String, Stripe::Account)) }
|
55
52
|
attr_reader :account
|
56
|
-
|
57
53
|
# Type of the account referenced.
|
58
54
|
sig { returns(String) }
|
59
55
|
attr_reader :type
|
@@ -61,11 +57,9 @@ module Stripe
|
|
61
57
|
# Indicates whether automatic tax is enabled for the session
|
62
58
|
sig { returns(T::Boolean) }
|
63
59
|
attr_reader :enabled
|
64
|
-
|
65
60
|
# 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.
|
66
61
|
sig { returns(T.nilable(Liability)) }
|
67
62
|
attr_reader :liability
|
68
|
-
|
69
63
|
# The status of the most recent automated tax calculation for this session.
|
70
64
|
sig { returns(T.nilable(String)) }
|
71
65
|
attr_reader :status
|
@@ -76,23 +70,18 @@ module Stripe
|
|
76
70
|
# City, district, suburb, town, or village.
|
77
71
|
sig { returns(T.nilable(String)) }
|
78
72
|
attr_reader :city
|
79
|
-
|
80
73
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
81
74
|
sig { returns(T.nilable(String)) }
|
82
75
|
attr_reader :country
|
83
|
-
|
84
76
|
# Address line 1 (e.g., street, PO Box, or company name).
|
85
77
|
sig { returns(T.nilable(String)) }
|
86
78
|
attr_reader :line1
|
87
|
-
|
88
79
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
89
80
|
sig { returns(T.nilable(String)) }
|
90
81
|
attr_reader :line2
|
91
|
-
|
92
82
|
# ZIP or postal code.
|
93
83
|
sig { returns(T.nilable(String)) }
|
94
84
|
attr_reader :postal_code
|
95
|
-
|
96
85
|
# State, county, province, or region.
|
97
86
|
sig { returns(T.nilable(String)) }
|
98
87
|
attr_reader :state
|
@@ -100,28 +89,23 @@ module Stripe
|
|
100
89
|
# Attribute for field address
|
101
90
|
sig { returns(Address) }
|
102
91
|
attr_reader :address
|
103
|
-
|
104
92
|
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
|
105
93
|
sig { returns(T.nilable(String)) }
|
106
94
|
attr_reader :carrier
|
107
|
-
|
108
95
|
# Recipient name.
|
109
96
|
sig { returns(String) }
|
110
97
|
attr_reader :name
|
111
|
-
|
112
98
|
# Recipient phone (including extension).
|
113
99
|
sig { returns(T.nilable(String)) }
|
114
100
|
attr_reader :phone
|
115
|
-
|
116
101
|
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
|
117
102
|
sig { returns(T.nilable(String)) }
|
118
103
|
attr_reader :tracking_number
|
119
104
|
end
|
120
105
|
class TaxId < Stripe::StripeObject
|
121
|
-
# 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`, `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`
|
106
|
+
# 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`
|
122
107
|
sig { returns(String) }
|
123
108
|
attr_reader :type
|
124
|
-
|
125
109
|
# The value of the tax ID.
|
126
110
|
sig { returns(T.nilable(String)) }
|
127
111
|
attr_reader :value
|
@@ -129,19 +113,15 @@ module Stripe
|
|
129
113
|
# Customer’s business name for this Checkout Session
|
130
114
|
sig { returns(T.nilable(String)) }
|
131
115
|
attr_reader :business_name
|
132
|
-
|
133
116
|
# Customer’s email for this Checkout Session
|
134
117
|
sig { returns(T.nilable(String)) }
|
135
118
|
attr_reader :email
|
136
|
-
|
137
119
|
# Customer’s phone number for this Checkout Session
|
138
120
|
sig { returns(T.nilable(String)) }
|
139
121
|
attr_reader :phone
|
140
|
-
|
141
122
|
# Shipping information for this Checkout Session.
|
142
123
|
sig { returns(T.nilable(ShippingDetails)) }
|
143
124
|
attr_reader :shipping_details
|
144
|
-
|
145
125
|
# Customer’s tax ids for this Checkout Session.
|
146
126
|
sig { returns(T.nilable(T::Array[TaxId])) }
|
147
127
|
attr_reader :tax_ids
|
@@ -151,7 +131,6 @@ module Stripe
|
|
151
131
|
# from the merchant about this Checkout Session.
|
152
132
|
sig { returns(T.nilable(String)) }
|
153
133
|
attr_reader :promotions
|
154
|
-
|
155
134
|
# If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.
|
156
135
|
sig { returns(T.nilable(String)) }
|
157
136
|
attr_reader :terms_of_service
|
@@ -167,13 +146,11 @@ module Stripe
|
|
167
146
|
# If set to `hidden`, it will hide legal text related to the reuse of a payment method.
|
168
147
|
sig { returns(T.nilable(PaymentMethodReuseAgreement)) }
|
169
148
|
attr_reader :payment_method_reuse_agreement
|
170
|
-
|
171
149
|
# If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
|
172
150
|
# Session will determine whether to display an option to opt into promotional communication
|
173
151
|
# from the merchant depending on the customer's locale. Only available to US merchants.
|
174
152
|
sig { returns(T.nilable(String)) }
|
175
153
|
attr_reader :promotions
|
176
|
-
|
177
154
|
# If set to `required`, it requires customers to accept the terms of service before being able to pay.
|
178
155
|
sig { returns(T.nilable(String)) }
|
179
156
|
attr_reader :terms_of_service
|
@@ -182,15 +159,12 @@ module Stripe
|
|
182
159
|
# Total of all items in source currency before discounts or taxes are applied.
|
183
160
|
sig { returns(Integer) }
|
184
161
|
attr_reader :amount_subtotal
|
185
|
-
|
186
162
|
# Total of all items in source currency after discounts and taxes are applied.
|
187
163
|
sig { returns(Integer) }
|
188
164
|
attr_reader :amount_total
|
189
|
-
|
190
165
|
# Exchange rate used to convert source currency amounts to customer currency amounts
|
191
166
|
sig { returns(String) }
|
192
167
|
attr_reader :fx_rate
|
193
|
-
|
194
168
|
# Creation currency of the CheckoutSession before localization
|
195
169
|
sig { returns(String) }
|
196
170
|
attr_reader :source_currency
|
@@ -201,7 +175,6 @@ module Stripe
|
|
201
175
|
# The label for the option, displayed to the customer. Up to 100 characters.
|
202
176
|
sig { returns(String) }
|
203
177
|
attr_reader :label
|
204
|
-
|
205
178
|
# The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
|
206
179
|
sig { returns(String) }
|
207
180
|
attr_reader :value
|
@@ -209,11 +182,9 @@ module Stripe
|
|
209
182
|
# The value that will pre-fill on the payment page.
|
210
183
|
sig { returns(T.nilable(String)) }
|
211
184
|
attr_reader :default_value
|
212
|
-
|
213
185
|
# The options available for the customer to select. Up to 200 options allowed.
|
214
186
|
sig { returns(T::Array[Option]) }
|
215
187
|
attr_reader :options
|
216
|
-
|
217
188
|
# The option selected by the customer. This will be the `value` for the option.
|
218
189
|
sig { returns(T.nilable(String)) }
|
219
190
|
attr_reader :value
|
@@ -222,7 +193,6 @@ module Stripe
|
|
222
193
|
# Custom text for the label, displayed to the customer. Up to 50 characters.
|
223
194
|
sig { returns(T.nilable(String)) }
|
224
195
|
attr_reader :custom
|
225
|
-
|
226
196
|
# The type of the label.
|
227
197
|
sig { returns(String) }
|
228
198
|
attr_reader :type
|
@@ -231,15 +201,12 @@ module Stripe
|
|
231
201
|
# The value that will pre-fill the field on the payment page.
|
232
202
|
sig { returns(T.nilable(String)) }
|
233
203
|
attr_reader :default_value
|
234
|
-
|
235
204
|
# The maximum character length constraint for the customer's input.
|
236
205
|
sig { returns(T.nilable(Integer)) }
|
237
206
|
attr_reader :maximum_length
|
238
|
-
|
239
207
|
# The minimum character length requirement for the customer's input.
|
240
208
|
sig { returns(T.nilable(Integer)) }
|
241
209
|
attr_reader :minimum_length
|
242
|
-
|
243
210
|
# The value entered by the customer, containing only digits.
|
244
211
|
sig { returns(T.nilable(String)) }
|
245
212
|
attr_reader :value
|
@@ -248,15 +215,12 @@ module Stripe
|
|
248
215
|
# The value that will pre-fill the field on the payment page.
|
249
216
|
sig { returns(T.nilable(String)) }
|
250
217
|
attr_reader :default_value
|
251
|
-
|
252
218
|
# The maximum character length constraint for the customer's input.
|
253
219
|
sig { returns(T.nilable(Integer)) }
|
254
220
|
attr_reader :maximum_length
|
255
|
-
|
256
221
|
# The minimum character length requirement for the customer's input.
|
257
222
|
sig { returns(T.nilable(Integer)) }
|
258
223
|
attr_reader :minimum_length
|
259
|
-
|
260
224
|
# The value entered by the customer.
|
261
225
|
sig { returns(T.nilable(String)) }
|
262
226
|
attr_reader :value
|
@@ -264,27 +228,21 @@ module Stripe
|
|
264
228
|
# Attribute for field dropdown
|
265
229
|
sig { returns(Dropdown) }
|
266
230
|
attr_reader :dropdown
|
267
|
-
|
268
231
|
# String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
|
269
232
|
sig { returns(String) }
|
270
233
|
attr_reader :key
|
271
|
-
|
272
234
|
# Attribute for field label
|
273
235
|
sig { returns(Label) }
|
274
236
|
attr_reader :label
|
275
|
-
|
276
237
|
# Attribute for field numeric
|
277
238
|
sig { returns(Numeric) }
|
278
239
|
attr_reader :numeric
|
279
|
-
|
280
240
|
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
|
281
241
|
sig { returns(T::Boolean) }
|
282
242
|
attr_reader :optional
|
283
|
-
|
284
243
|
# Attribute for field text
|
285
244
|
sig { returns(Text) }
|
286
245
|
attr_reader :text
|
287
|
-
|
288
246
|
# The type of the field.
|
289
247
|
sig { returns(String) }
|
290
248
|
attr_reader :type
|
@@ -313,15 +271,12 @@ module Stripe
|
|
313
271
|
# Custom text that should be displayed after the payment confirmation button.
|
314
272
|
sig { returns(T.nilable(AfterSubmit)) }
|
315
273
|
attr_reader :after_submit
|
316
|
-
|
317
274
|
# Custom text that should be displayed alongside shipping address collection.
|
318
275
|
sig { returns(T.nilable(ShippingAddress)) }
|
319
276
|
attr_reader :shipping_address
|
320
|
-
|
321
277
|
# Custom text that should be displayed alongside the payment confirmation button.
|
322
278
|
sig { returns(T.nilable(Submit)) }
|
323
279
|
attr_reader :submit
|
324
|
-
|
325
280
|
# Custom text that should be displayed in place of the default terms of service agreement text.
|
326
281
|
sig { returns(T.nilable(TermsOfServiceAcceptance)) }
|
327
282
|
attr_reader :terms_of_service_acceptance
|
@@ -331,32 +286,26 @@ module Stripe
|
|
331
286
|
# City, district, suburb, town, or village.
|
332
287
|
sig { returns(T.nilable(String)) }
|
333
288
|
attr_reader :city
|
334
|
-
|
335
289
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
336
290
|
sig { returns(T.nilable(String)) }
|
337
291
|
attr_reader :country
|
338
|
-
|
339
292
|
# Address line 1 (e.g., street, PO Box, or company name).
|
340
293
|
sig { returns(T.nilable(String)) }
|
341
294
|
attr_reader :line1
|
342
|
-
|
343
295
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
344
296
|
sig { returns(T.nilable(String)) }
|
345
297
|
attr_reader :line2
|
346
|
-
|
347
298
|
# ZIP or postal code.
|
348
299
|
sig { returns(T.nilable(String)) }
|
349
300
|
attr_reader :postal_code
|
350
|
-
|
351
301
|
# State, county, province, or region.
|
352
302
|
sig { returns(T.nilable(String)) }
|
353
303
|
attr_reader :state
|
354
304
|
end
|
355
305
|
class TaxId < Stripe::StripeObject
|
356
|
-
# 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`, `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`
|
306
|
+
# 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`
|
357
307
|
sig { returns(String) }
|
358
308
|
attr_reader :type
|
359
|
-
|
360
309
|
# The value of the tax ID.
|
361
310
|
sig { returns(T.nilable(String)) }
|
362
311
|
attr_reader :value
|
@@ -364,24 +313,19 @@ module Stripe
|
|
364
313
|
# The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
|
365
314
|
sig { returns(T.nilable(Address)) }
|
366
315
|
attr_reader :address
|
367
|
-
|
368
316
|
# The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.
|
369
317
|
# Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.
|
370
318
|
sig { returns(T.nilable(String)) }
|
371
319
|
attr_reader :email
|
372
|
-
|
373
320
|
# The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
|
374
321
|
sig { returns(T.nilable(String)) }
|
375
322
|
attr_reader :name
|
376
|
-
|
377
323
|
# The customer's phone number after a completed Checkout Session.
|
378
324
|
sig { returns(T.nilable(String)) }
|
379
325
|
attr_reader :phone
|
380
|
-
|
381
326
|
# The customer’s tax exempt status after a completed Checkout Session.
|
382
327
|
sig { returns(T.nilable(String)) }
|
383
328
|
attr_reader :tax_exempt
|
384
|
-
|
385
329
|
# The customer’s tax IDs after a completed Checkout Session.
|
386
330
|
sig { returns(T.nilable(T::Array[TaxId])) }
|
387
331
|
attr_reader :tax_ids
|
@@ -392,7 +336,6 @@ module Stripe
|
|
392
336
|
# The name of the custom field.
|
393
337
|
sig { returns(String) }
|
394
338
|
attr_reader :name
|
395
|
-
|
396
339
|
# The value of the custom field.
|
397
340
|
sig { returns(String) }
|
398
341
|
attr_reader :value
|
@@ -401,7 +344,6 @@ module Stripe
|
|
401
344
|
# The connected account being referenced when `type` is `account`.
|
402
345
|
sig { returns(T.any(String, Stripe::Account)) }
|
403
346
|
attr_reader :account
|
404
|
-
|
405
347
|
# Type of the account referenced.
|
406
348
|
sig { returns(String) }
|
407
349
|
attr_reader :type
|
@@ -414,27 +356,21 @@ module Stripe
|
|
414
356
|
# The account tax IDs associated with the invoice.
|
415
357
|
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
|
416
358
|
attr_reader :account_tax_ids
|
417
|
-
|
418
359
|
# Custom fields displayed on the invoice.
|
419
360
|
sig { returns(T.nilable(T::Array[CustomField])) }
|
420
361
|
attr_reader :custom_fields
|
421
|
-
|
422
362
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
423
363
|
sig { returns(T.nilable(String)) }
|
424
364
|
attr_reader :description
|
425
|
-
|
426
365
|
# Footer displayed on the invoice.
|
427
366
|
sig { returns(T.nilable(String)) }
|
428
367
|
attr_reader :footer
|
429
|
-
|
430
368
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
431
369
|
sig { returns(T.nilable(Issuer)) }
|
432
370
|
attr_reader :issuer
|
433
|
-
|
434
371
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
435
372
|
sig { returns(T.nilable(T::Hash[String, String])) }
|
436
373
|
attr_reader :metadata
|
437
|
-
|
438
374
|
# Options for invoice PDF rendering.
|
439
375
|
sig { returns(T.nilable(RenderingOptions)) }
|
440
376
|
attr_reader :rendering_options
|
@@ -442,7 +378,6 @@ module Stripe
|
|
442
378
|
# Indicates whether invoice creation is enabled for the Checkout Session.
|
443
379
|
sig { returns(T::Boolean) }
|
444
380
|
attr_reader :enabled
|
445
|
-
|
446
381
|
# Attribute for field invoice_data
|
447
382
|
sig { returns(InvoiceData) }
|
448
383
|
attr_reader :invoice_data
|
@@ -451,7 +386,6 @@ module Stripe
|
|
451
386
|
# ID of the payment method configuration used.
|
452
387
|
sig { returns(String) }
|
453
388
|
attr_reader :id
|
454
|
-
|
455
389
|
# ID of the parent payment method configuration used.
|
456
390
|
sig { returns(T.nilable(String)) }
|
457
391
|
attr_reader :parent
|
@@ -462,19 +396,15 @@ module Stripe
|
|
462
396
|
# A URL for custom mandate text
|
463
397
|
sig { returns(String) }
|
464
398
|
attr_reader :custom_mandate_url
|
465
|
-
|
466
399
|
# List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.
|
467
400
|
sig { returns(T::Array[String]) }
|
468
401
|
attr_reader :default_for
|
469
|
-
|
470
402
|
# Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
|
471
403
|
sig { returns(T.nilable(String)) }
|
472
404
|
attr_reader :interval_description
|
473
|
-
|
474
405
|
# Payment schedule for the mandate.
|
475
406
|
sig { returns(T.nilable(String)) }
|
476
407
|
attr_reader :payment_schedule
|
477
|
-
|
478
408
|
# Transaction type of the mandate.
|
479
409
|
sig { returns(T.nilable(String)) }
|
480
410
|
attr_reader :transaction_type
|
@@ -482,11 +412,9 @@ module Stripe
|
|
482
412
|
# Currency supported by the bank account. Returned when the Session is in `setup` mode.
|
483
413
|
sig { returns(String) }
|
484
414
|
attr_reader :currency
|
485
|
-
|
486
415
|
# Attribute for field mandate_options
|
487
416
|
sig { returns(MandateOptions) }
|
488
417
|
attr_reader :mandate_options
|
489
|
-
|
490
418
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
491
419
|
#
|
492
420
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -496,7 +424,6 @@ module Stripe
|
|
496
424
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
497
425
|
sig { returns(String) }
|
498
426
|
attr_reader :setup_future_usage
|
499
|
-
|
500
427
|
# Bank account verification method.
|
501
428
|
sig { returns(String) }
|
502
429
|
attr_reader :verification_method
|
@@ -565,7 +492,6 @@ module Stripe
|
|
565
492
|
# Attribute for field mandate_options
|
566
493
|
sig { returns(MandateOptions) }
|
567
494
|
attr_reader :mandate_options
|
568
|
-
|
569
495
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
570
496
|
#
|
571
497
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -591,7 +517,6 @@ module Stripe
|
|
591
517
|
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
|
592
518
|
sig { returns(Integer) }
|
593
519
|
attr_reader :expires_after_days
|
594
|
-
|
595
520
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
596
521
|
#
|
597
522
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -611,31 +536,24 @@ module Stripe
|
|
611
536
|
# Attribute for field installments
|
612
537
|
sig { returns(Installments) }
|
613
538
|
attr_reader :installments
|
614
|
-
|
615
539
|
# Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
|
616
540
|
sig { returns(String) }
|
617
541
|
attr_reader :request_decremental_authorization
|
618
|
-
|
619
542
|
# Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
|
620
543
|
sig { returns(String) }
|
621
544
|
attr_reader :request_extended_authorization
|
622
|
-
|
623
545
|
# Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
|
624
546
|
sig { returns(String) }
|
625
547
|
attr_reader :request_incremental_authorization
|
626
|
-
|
627
548
|
# Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
|
628
549
|
sig { returns(String) }
|
629
550
|
attr_reader :request_multicapture
|
630
|
-
|
631
551
|
# Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
|
632
552
|
sig { returns(String) }
|
633
553
|
attr_reader :request_overcapture
|
634
|
-
|
635
554
|
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
636
555
|
sig { returns(String) }
|
637
556
|
attr_reader :request_three_d_secure
|
638
|
-
|
639
557
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
640
558
|
#
|
641
559
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -645,11 +563,9 @@ module Stripe
|
|
645
563
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
646
564
|
sig { returns(String) }
|
647
565
|
attr_reader :setup_future_usage
|
648
|
-
|
649
566
|
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
|
650
567
|
sig { returns(String) }
|
651
568
|
attr_reader :statement_descriptor_suffix_kana
|
652
|
-
|
653
569
|
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
|
654
570
|
sig { returns(String) }
|
655
571
|
attr_reader :statement_descriptor_suffix_kanji
|
@@ -675,13 +591,11 @@ module Stripe
|
|
675
591
|
# Attribute for field eu_bank_transfer
|
676
592
|
sig { returns(EuBankTransfer) }
|
677
593
|
attr_reader :eu_bank_transfer
|
678
|
-
|
679
594
|
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
|
680
595
|
#
|
681
596
|
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
|
682
597
|
sig { returns(T::Array[String]) }
|
683
598
|
attr_reader :requested_address_types
|
684
|
-
|
685
599
|
# The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
|
686
600
|
sig { returns(T.nilable(String)) }
|
687
601
|
attr_reader :type
|
@@ -689,11 +603,9 @@ module Stripe
|
|
689
603
|
# Attribute for field bank_transfer
|
690
604
|
sig { returns(BankTransfer) }
|
691
605
|
attr_reader :bank_transfer
|
692
|
-
|
693
606
|
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
|
694
607
|
sig { returns(T.nilable(String)) }
|
695
608
|
attr_reader :funding_type
|
696
|
-
|
697
609
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
698
610
|
#
|
699
611
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -763,7 +675,6 @@ module Stripe
|
|
763
675
|
# Controls when the funds will be captured from the customer's account.
|
764
676
|
sig { returns(String) }
|
765
677
|
attr_reader :capture_method
|
766
|
-
|
767
678
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
768
679
|
#
|
769
680
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -789,7 +700,6 @@ module Stripe
|
|
789
700
|
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.
|
790
701
|
sig { returns(T.nilable(Integer)) }
|
791
702
|
attr_reader :expires_after_days
|
792
|
-
|
793
703
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
794
704
|
#
|
795
705
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -804,7 +714,6 @@ module Stripe
|
|
804
714
|
# Controls when the funds will be captured from the customer's account.
|
805
715
|
sig { returns(String) }
|
806
716
|
attr_reader :capture_method
|
807
|
-
|
808
717
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
809
718
|
#
|
810
719
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -857,7 +766,6 @@ module Stripe
|
|
857
766
|
# The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
|
858
767
|
sig { returns(Integer) }
|
859
768
|
attr_reader :expires_after_days
|
860
|
-
|
861
769
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
862
770
|
#
|
863
771
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -899,15 +807,12 @@ module Stripe
|
|
899
807
|
# Controls when the funds will be captured from the customer's account.
|
900
808
|
sig { returns(String) }
|
901
809
|
attr_reader :capture_method
|
902
|
-
|
903
810
|
# Preferred locale of the PayPal checkout page that the customer is redirected to.
|
904
811
|
sig { returns(T.nilable(String)) }
|
905
812
|
attr_reader :preferred_locale
|
906
|
-
|
907
813
|
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
|
908
814
|
sig { returns(T.nilable(String)) }
|
909
815
|
attr_reader :reference
|
910
|
-
|
911
816
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
912
817
|
#
|
913
818
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -917,7 +822,6 @@ module Stripe
|
|
917
822
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
918
823
|
sig { returns(String) }
|
919
824
|
attr_reader :setup_future_usage
|
920
|
-
|
921
825
|
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
|
922
826
|
sig { returns(T::Array[String]) }
|
923
827
|
attr_reader :subsellers
|
@@ -927,27 +831,21 @@ module Stripe
|
|
927
831
|
# Amount that will be collected. It is required when `amount_type` is `fixed`.
|
928
832
|
sig { returns(T.nilable(Integer)) }
|
929
833
|
attr_reader :amount
|
930
|
-
|
931
834
|
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
|
932
835
|
sig { returns(T.nilable(String)) }
|
933
836
|
attr_reader :amount_type
|
934
|
-
|
935
837
|
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
936
838
|
sig { returns(T.nilable(String)) }
|
937
839
|
attr_reader :end_date
|
938
|
-
|
939
840
|
# The periodicity at which payments will be collected.
|
940
841
|
sig { returns(T.nilable(String)) }
|
941
842
|
attr_reader :payment_schedule
|
942
|
-
|
943
843
|
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
|
944
844
|
sig { returns(T.nilable(Integer)) }
|
945
845
|
attr_reader :payments_per_period
|
946
|
-
|
947
846
|
# The purpose for which payments are made. Defaults to retail.
|
948
847
|
sig { returns(T.nilable(String)) }
|
949
848
|
attr_reader :purpose
|
950
|
-
|
951
849
|
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
952
850
|
sig { returns(T.nilable(String)) }
|
953
851
|
attr_reader :start_date
|
@@ -955,7 +853,6 @@ module Stripe
|
|
955
853
|
# Attribute for field mandate_options
|
956
854
|
sig { returns(MandateOptions) }
|
957
855
|
attr_reader :mandate_options
|
958
|
-
|
959
856
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
960
857
|
#
|
961
858
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -996,7 +893,6 @@ module Stripe
|
|
996
893
|
# Attribute for field mandate_options
|
997
894
|
sig { returns(MandateOptions) }
|
998
895
|
attr_reader :mandate_options
|
999
|
-
|
1000
896
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
1001
897
|
#
|
1002
898
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -1029,7 +925,6 @@ module Stripe
|
|
1029
925
|
# The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
|
1030
926
|
sig { returns(T::Array[String]) }
|
1031
927
|
attr_reader :account_subcategories
|
1032
|
-
|
1033
928
|
# The institution to use to filter for possible accounts to link.
|
1034
929
|
sig { returns(String) }
|
1035
930
|
attr_reader :institution
|
@@ -1042,19 +937,15 @@ module Stripe
|
|
1042
937
|
# Attribute for field filters
|
1043
938
|
sig { returns(Filters) }
|
1044
939
|
attr_reader :filters
|
1045
|
-
|
1046
940
|
# Attribute for field manual_entry
|
1047
941
|
sig { returns(ManualEntry) }
|
1048
942
|
attr_reader :manual_entry
|
1049
|
-
|
1050
943
|
# The list of permissions to request. The `payment_method` permission must be included.
|
1051
944
|
sig { returns(T::Array[String]) }
|
1052
945
|
attr_reader :permissions
|
1053
|
-
|
1054
946
|
# Data features requested to be retrieved upon account creation.
|
1055
947
|
sig { returns(T.nilable(T::Array[String])) }
|
1056
948
|
attr_reader :prefetch
|
1057
|
-
|
1058
949
|
# For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
|
1059
950
|
sig { returns(String) }
|
1060
951
|
attr_reader :return_url
|
@@ -1062,7 +953,6 @@ module Stripe
|
|
1062
953
|
# Attribute for field financial_connections
|
1063
954
|
sig { returns(FinancialConnections) }
|
1064
955
|
attr_reader :financial_connections
|
1065
|
-
|
1066
956
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
1067
957
|
#
|
1068
958
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -1072,7 +962,6 @@ module Stripe
|
|
1072
962
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
1073
963
|
sig { returns(String) }
|
1074
964
|
attr_reader :setup_future_usage
|
1075
|
-
|
1076
965
|
# Bank account verification method.
|
1077
966
|
sig { returns(String) }
|
1078
967
|
attr_reader :verification_method
|
@@ -1080,151 +969,114 @@ module Stripe
|
|
1080
969
|
# Attribute for field acss_debit
|
1081
970
|
sig { returns(AcssDebit) }
|
1082
971
|
attr_reader :acss_debit
|
1083
|
-
|
1084
972
|
# Attribute for field affirm
|
1085
973
|
sig { returns(Affirm) }
|
1086
974
|
attr_reader :affirm
|
1087
|
-
|
1088
975
|
# Attribute for field afterpay_clearpay
|
1089
976
|
sig { returns(AfterpayClearpay) }
|
1090
977
|
attr_reader :afterpay_clearpay
|
1091
|
-
|
1092
978
|
# Attribute for field alipay
|
1093
979
|
sig { returns(Alipay) }
|
1094
980
|
attr_reader :alipay
|
1095
|
-
|
1096
981
|
# Attribute for field amazon_pay
|
1097
982
|
sig { returns(AmazonPay) }
|
1098
983
|
attr_reader :amazon_pay
|
1099
|
-
|
1100
984
|
# Attribute for field au_becs_debit
|
1101
985
|
sig { returns(AuBecsDebit) }
|
1102
986
|
attr_reader :au_becs_debit
|
1103
|
-
|
1104
987
|
# Attribute for field bacs_debit
|
1105
988
|
sig { returns(BacsDebit) }
|
1106
989
|
attr_reader :bacs_debit
|
1107
|
-
|
1108
990
|
# Attribute for field bancontact
|
1109
991
|
sig { returns(Bancontact) }
|
1110
992
|
attr_reader :bancontact
|
1111
|
-
|
1112
993
|
# Attribute for field boleto
|
1113
994
|
sig { returns(Boleto) }
|
1114
995
|
attr_reader :boleto
|
1115
|
-
|
1116
996
|
# Attribute for field card
|
1117
997
|
sig { returns(Card) }
|
1118
998
|
attr_reader :card
|
1119
|
-
|
1120
999
|
# Attribute for field cashapp
|
1121
1000
|
sig { returns(Cashapp) }
|
1122
1001
|
attr_reader :cashapp
|
1123
|
-
|
1124
1002
|
# Attribute for field customer_balance
|
1125
1003
|
sig { returns(CustomerBalance) }
|
1126
1004
|
attr_reader :customer_balance
|
1127
|
-
|
1128
1005
|
# Attribute for field eps
|
1129
1006
|
sig { returns(Eps) }
|
1130
1007
|
attr_reader :eps
|
1131
|
-
|
1132
1008
|
# Attribute for field fpx
|
1133
1009
|
sig { returns(Fpx) }
|
1134
1010
|
attr_reader :fpx
|
1135
|
-
|
1136
1011
|
# Attribute for field giropay
|
1137
1012
|
sig { returns(Giropay) }
|
1138
1013
|
attr_reader :giropay
|
1139
|
-
|
1140
1014
|
# Attribute for field grabpay
|
1141
1015
|
sig { returns(Grabpay) }
|
1142
1016
|
attr_reader :grabpay
|
1143
|
-
|
1144
1017
|
# Attribute for field ideal
|
1145
1018
|
sig { returns(Ideal) }
|
1146
1019
|
attr_reader :ideal
|
1147
|
-
|
1148
1020
|
# Attribute for field kakao_pay
|
1149
1021
|
sig { returns(KakaoPay) }
|
1150
1022
|
attr_reader :kakao_pay
|
1151
|
-
|
1152
1023
|
# Attribute for field klarna
|
1153
1024
|
sig { returns(Klarna) }
|
1154
1025
|
attr_reader :klarna
|
1155
|
-
|
1156
1026
|
# Attribute for field konbini
|
1157
1027
|
sig { returns(Konbini) }
|
1158
1028
|
attr_reader :konbini
|
1159
|
-
|
1160
1029
|
# Attribute for field kr_card
|
1161
1030
|
sig { returns(KrCard) }
|
1162
1031
|
attr_reader :kr_card
|
1163
|
-
|
1164
1032
|
# Attribute for field link
|
1165
1033
|
sig { returns(Link) }
|
1166
1034
|
attr_reader :link
|
1167
|
-
|
1168
1035
|
# Attribute for field mobilepay
|
1169
1036
|
sig { returns(Mobilepay) }
|
1170
1037
|
attr_reader :mobilepay
|
1171
|
-
|
1172
1038
|
# Attribute for field multibanco
|
1173
1039
|
sig { returns(Multibanco) }
|
1174
1040
|
attr_reader :multibanco
|
1175
|
-
|
1176
1041
|
# Attribute for field naver_pay
|
1177
1042
|
sig { returns(NaverPay) }
|
1178
1043
|
attr_reader :naver_pay
|
1179
|
-
|
1180
1044
|
# Attribute for field oxxo
|
1181
1045
|
sig { returns(Oxxo) }
|
1182
1046
|
attr_reader :oxxo
|
1183
|
-
|
1184
1047
|
# Attribute for field p24
|
1185
1048
|
sig { returns(P24) }
|
1186
1049
|
attr_reader :p24
|
1187
|
-
|
1188
1050
|
# Attribute for field payco
|
1189
1051
|
sig { returns(Payco) }
|
1190
1052
|
attr_reader :payco
|
1191
|
-
|
1192
1053
|
# Attribute for field paynow
|
1193
1054
|
sig { returns(Paynow) }
|
1194
1055
|
attr_reader :paynow
|
1195
|
-
|
1196
1056
|
# Attribute for field paypal
|
1197
1057
|
sig { returns(Paypal) }
|
1198
1058
|
attr_reader :paypal
|
1199
|
-
|
1200
1059
|
# Attribute for field payto
|
1201
1060
|
sig { returns(Payto) }
|
1202
1061
|
attr_reader :payto
|
1203
|
-
|
1204
1062
|
# Attribute for field pix
|
1205
1063
|
sig { returns(Pix) }
|
1206
1064
|
attr_reader :pix
|
1207
|
-
|
1208
1065
|
# Attribute for field revolut_pay
|
1209
1066
|
sig { returns(RevolutPay) }
|
1210
1067
|
attr_reader :revolut_pay
|
1211
|
-
|
1212
1068
|
# Attribute for field samsung_pay
|
1213
1069
|
sig { returns(SamsungPay) }
|
1214
1070
|
attr_reader :samsung_pay
|
1215
|
-
|
1216
1071
|
# Attribute for field sepa_debit
|
1217
1072
|
sig { returns(SepaDebit) }
|
1218
1073
|
attr_reader :sepa_debit
|
1219
|
-
|
1220
1074
|
# Attribute for field sofort
|
1221
1075
|
sig { returns(Sofort) }
|
1222
1076
|
attr_reader :sofort
|
1223
|
-
|
1224
1077
|
# Attribute for field swish
|
1225
1078
|
sig { returns(Swish) }
|
1226
1079
|
attr_reader :swish
|
1227
|
-
|
1228
1080
|
# Attribute for field us_bank_account
|
1229
1081
|
sig { returns(UsBankAccount) }
|
1230
1082
|
attr_reader :us_bank_account
|
@@ -1238,7 +1090,6 @@ module Stripe
|
|
1238
1090
|
# When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
|
1239
1091
|
sig { returns(T.nilable(String)) }
|
1240
1092
|
attr_reader :line_items
|
1241
|
-
|
1242
1093
|
# Determines which entity is allowed to update the shipping details.
|
1243
1094
|
#
|
1244
1095
|
# Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
|
@@ -1260,11 +1111,9 @@ module Stripe
|
|
1260
1111
|
# Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.
|
1261
1112
|
sig { returns(T.nilable(T::Array[String])) }
|
1262
1113
|
attr_reader :allow_redisplay_filters
|
1263
|
-
|
1264
1114
|
# Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
|
1265
1115
|
sig { returns(T.nilable(String)) }
|
1266
1116
|
attr_reader :payment_method_remove
|
1267
|
-
|
1268
1117
|
# Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
|
1269
1118
|
sig { returns(T.nilable(String)) }
|
1270
1119
|
attr_reader :payment_method_save
|
@@ -1280,17 +1129,14 @@ module Stripe
|
|
1280
1129
|
# Amount of tax applied for this rate.
|
1281
1130
|
sig { returns(Integer) }
|
1282
1131
|
attr_reader :amount
|
1283
|
-
|
1284
1132
|
# Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
|
1285
1133
|
#
|
1286
1134
|
# Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)
|
1287
1135
|
sig { returns(Stripe::TaxRate) }
|
1288
1136
|
attr_reader :rate
|
1289
|
-
|
1290
1137
|
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
|
1291
1138
|
sig { returns(T.nilable(String)) }
|
1292
1139
|
attr_reader :taxability_reason
|
1293
|
-
|
1294
1140
|
# The amount on which tax is calculated, in cents (or local equivalent).
|
1295
1141
|
sig { returns(T.nilable(Integer)) }
|
1296
1142
|
attr_reader :taxable_amount
|
@@ -1298,19 +1144,15 @@ module Stripe
|
|
1298
1144
|
# Total shipping cost before any discounts or taxes are applied.
|
1299
1145
|
sig { returns(Integer) }
|
1300
1146
|
attr_reader :amount_subtotal
|
1301
|
-
|
1302
1147
|
# Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
|
1303
1148
|
sig { returns(Integer) }
|
1304
1149
|
attr_reader :amount_tax
|
1305
|
-
|
1306
1150
|
# Total shipping cost after discounts and taxes are applied.
|
1307
1151
|
sig { returns(Integer) }
|
1308
1152
|
attr_reader :amount_total
|
1309
|
-
|
1310
1153
|
# The ID of the ShippingRate for this order.
|
1311
1154
|
sig { returns(T.nilable(T.any(String, Stripe::ShippingRate))) }
|
1312
1155
|
attr_reader :shipping_rate
|
1313
|
-
|
1314
1156
|
# The taxes applied to the shipping rate.
|
1315
1157
|
sig { returns(T::Array[Tax]) }
|
1316
1158
|
attr_reader :taxes
|
@@ -1320,23 +1162,18 @@ module Stripe
|
|
1320
1162
|
# City, district, suburb, town, or village.
|
1321
1163
|
sig { returns(T.nilable(String)) }
|
1322
1164
|
attr_reader :city
|
1323
|
-
|
1324
1165
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
1325
1166
|
sig { returns(T.nilable(String)) }
|
1326
1167
|
attr_reader :country
|
1327
|
-
|
1328
1168
|
# Address line 1 (e.g., street, PO Box, or company name).
|
1329
1169
|
sig { returns(T.nilable(String)) }
|
1330
1170
|
attr_reader :line1
|
1331
|
-
|
1332
1171
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
1333
1172
|
sig { returns(T.nilable(String)) }
|
1334
1173
|
attr_reader :line2
|
1335
|
-
|
1336
1174
|
# ZIP or postal code.
|
1337
1175
|
sig { returns(T.nilable(String)) }
|
1338
1176
|
attr_reader :postal_code
|
1339
|
-
|
1340
1177
|
# State, county, province, or region.
|
1341
1178
|
sig { returns(T.nilable(String)) }
|
1342
1179
|
attr_reader :state
|
@@ -1344,19 +1181,15 @@ module Stripe
|
|
1344
1181
|
# Attribute for field address
|
1345
1182
|
sig { returns(Address) }
|
1346
1183
|
attr_reader :address
|
1347
|
-
|
1348
1184
|
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
|
1349
1185
|
sig { returns(T.nilable(String)) }
|
1350
1186
|
attr_reader :carrier
|
1351
|
-
|
1352
1187
|
# Recipient name.
|
1353
1188
|
sig { returns(String) }
|
1354
1189
|
attr_reader :name
|
1355
|
-
|
1356
1190
|
# Recipient phone (including extension).
|
1357
1191
|
sig { returns(T.nilable(String)) }
|
1358
1192
|
attr_reader :phone
|
1359
|
-
|
1360
1193
|
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
|
1361
1194
|
sig { returns(T.nilable(String)) }
|
1362
1195
|
attr_reader :tracking_number
|
@@ -1365,7 +1198,6 @@ module Stripe
|
|
1365
1198
|
# A non-negative integer in cents representing how much to charge.
|
1366
1199
|
sig { returns(Integer) }
|
1367
1200
|
attr_reader :shipping_amount
|
1368
|
-
|
1369
1201
|
# The shipping rate.
|
1370
1202
|
sig { returns(T.any(String, Stripe::ShippingRate)) }
|
1371
1203
|
attr_reader :shipping_rate
|
@@ -1374,7 +1206,6 @@ module Stripe
|
|
1374
1206
|
# Indicates whether tax ID collection is enabled for the session
|
1375
1207
|
sig { returns(T::Boolean) }
|
1376
1208
|
attr_reader :enabled
|
1377
|
-
|
1378
1209
|
# Indicates whether a tax ID is required on the payment page
|
1379
1210
|
sig { returns(String) }
|
1380
1211
|
attr_reader :required
|
@@ -1385,7 +1216,6 @@ module Stripe
|
|
1385
1216
|
# The amount discounted.
|
1386
1217
|
sig { returns(Integer) }
|
1387
1218
|
attr_reader :amount
|
1388
|
-
|
1389
1219
|
# A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
|
1390
1220
|
# It contains information about when the discount began, when it will end, and what it is applied to.
|
1391
1221
|
#
|
@@ -1397,17 +1227,14 @@ module Stripe
|
|
1397
1227
|
# Amount of tax applied for this rate.
|
1398
1228
|
sig { returns(Integer) }
|
1399
1229
|
attr_reader :amount
|
1400
|
-
|
1401
1230
|
# Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
|
1402
1231
|
#
|
1403
1232
|
# Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)
|
1404
1233
|
sig { returns(Stripe::TaxRate) }
|
1405
1234
|
attr_reader :rate
|
1406
|
-
|
1407
1235
|
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
|
1408
1236
|
sig { returns(T.nilable(String)) }
|
1409
1237
|
attr_reader :taxability_reason
|
1410
|
-
|
1411
1238
|
# The amount on which tax is calculated, in cents (or local equivalent).
|
1412
1239
|
sig { returns(T.nilable(Integer)) }
|
1413
1240
|
attr_reader :taxable_amount
|
@@ -1415,7 +1242,6 @@ module Stripe
|
|
1415
1242
|
# The aggregated discounts.
|
1416
1243
|
sig { returns(T::Array[Discount]) }
|
1417
1244
|
attr_reader :discounts
|
1418
|
-
|
1419
1245
|
# The aggregated tax amounts by rate.
|
1420
1246
|
sig { returns(T::Array[Tax]) }
|
1421
1247
|
attr_reader :taxes
|
@@ -1423,15 +1249,12 @@ module Stripe
|
|
1423
1249
|
# This is the sum of all the discounts.
|
1424
1250
|
sig { returns(Integer) }
|
1425
1251
|
attr_reader :amount_discount
|
1426
|
-
|
1427
1252
|
# This is the sum of all the shipping amounts.
|
1428
1253
|
sig { returns(T.nilable(Integer)) }
|
1429
1254
|
attr_reader :amount_shipping
|
1430
|
-
|
1431
1255
|
# This is the sum of all the tax amounts.
|
1432
1256
|
sig { returns(Integer) }
|
1433
1257
|
attr_reader :amount_tax
|
1434
|
-
|
1435
1258
|
# Attribute for field breakdown
|
1436
1259
|
sig { returns(Breakdown) }
|
1437
1260
|
attr_reader :breakdown
|
@@ -1439,77 +1262,59 @@ module Stripe
|
|
1439
1262
|
# Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
|
1440
1263
|
sig { returns(T.nilable(AdaptivePricing)) }
|
1441
1264
|
attr_reader :adaptive_pricing
|
1442
|
-
|
1443
1265
|
# When set, provides configuration for actions to take if this Checkout Session expires.
|
1444
1266
|
sig { returns(T.nilable(AfterExpiration)) }
|
1445
1267
|
attr_reader :after_expiration
|
1446
|
-
|
1447
1268
|
# Enables user redeemable promotion codes.
|
1448
1269
|
sig { returns(T.nilable(T::Boolean)) }
|
1449
1270
|
attr_reader :allow_promotion_codes
|
1450
|
-
|
1451
1271
|
# Total of all items before discounts or taxes are applied.
|
1452
1272
|
sig { returns(T.nilable(Integer)) }
|
1453
1273
|
attr_reader :amount_subtotal
|
1454
|
-
|
1455
1274
|
# Total of all items after discounts and taxes are applied.
|
1456
1275
|
sig { returns(T.nilable(Integer)) }
|
1457
1276
|
attr_reader :amount_total
|
1458
|
-
|
1459
1277
|
# Attribute for field automatic_tax
|
1460
1278
|
sig { returns(AutomaticTax) }
|
1461
1279
|
attr_reader :automatic_tax
|
1462
|
-
|
1463
1280
|
# Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.
|
1464
1281
|
sig { returns(T.nilable(String)) }
|
1465
1282
|
attr_reader :billing_address_collection
|
1466
|
-
|
1467
1283
|
# If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
|
1468
1284
|
sig { returns(T.nilable(String)) }
|
1469
1285
|
attr_reader :cancel_url
|
1470
|
-
|
1471
1286
|
# A unique string to reference the Checkout Session. This can be a
|
1472
1287
|
# customer ID, a cart ID, or similar, and can be used to reconcile the
|
1473
1288
|
# Session with your internal systems.
|
1474
1289
|
sig { returns(T.nilable(String)) }
|
1475
1290
|
attr_reader :client_reference_id
|
1476
|
-
|
1477
1291
|
# The client secret of the Session. Use this with [initCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.
|
1478
1292
|
sig { returns(T.nilable(String)) }
|
1479
1293
|
attr_reader :client_secret
|
1480
|
-
|
1481
1294
|
# Information about the customer collected within the Checkout Session.
|
1482
1295
|
sig { returns(T.nilable(CollectedInformation)) }
|
1483
1296
|
attr_reader :collected_information
|
1484
|
-
|
1485
1297
|
# Results of `consent_collection` for this session.
|
1486
1298
|
sig { returns(T.nilable(Consent)) }
|
1487
1299
|
attr_reader :consent
|
1488
|
-
|
1489
1300
|
# When set, provides configuration for the Checkout Session to gather active consent from customers.
|
1490
1301
|
sig { returns(T.nilable(ConsentCollection)) }
|
1491
1302
|
attr_reader :consent_collection
|
1492
|
-
|
1493
1303
|
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
1494
1304
|
sig { returns(Integer) }
|
1495
1305
|
attr_reader :created
|
1496
|
-
|
1497
1306
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
1498
1307
|
sig { returns(T.nilable(String)) }
|
1499
1308
|
attr_reader :currency
|
1500
|
-
|
1501
1309
|
# Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions
|
1502
1310
|
sig { returns(T.nilable(CurrencyConversion)) }
|
1503
1311
|
attr_reader :currency_conversion
|
1504
|
-
|
1505
1312
|
# Collect additional information from your customer using custom fields. Up to 3 fields are supported.
|
1506
1313
|
sig { returns(T::Array[CustomField]) }
|
1507
1314
|
attr_reader :custom_fields
|
1508
|
-
|
1509
1315
|
# Attribute for field custom_text
|
1510
1316
|
sig { returns(CustomText) }
|
1511
1317
|
attr_reader :custom_text
|
1512
|
-
|
1513
1318
|
# The ID of the customer for this Session.
|
1514
1319
|
# For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout
|
1515
1320
|
# will create a new customer object based on information provided
|
@@ -1517,15 +1322,12 @@ module Stripe
|
|
1517
1322
|
# the Session was created.
|
1518
1323
|
sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
|
1519
1324
|
attr_reader :customer
|
1520
|
-
|
1521
1325
|
# Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
|
1522
1326
|
sig { returns(T.nilable(String)) }
|
1523
1327
|
attr_reader :customer_creation
|
1524
|
-
|
1525
1328
|
# The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.
|
1526
1329
|
sig { returns(T.nilable(CustomerDetails)) }
|
1527
1330
|
attr_reader :customer_details
|
1528
|
-
|
1529
1331
|
# If provided, this value will be used when the Customer object is created.
|
1530
1332
|
# If not provided, customers will be asked to enter their email address.
|
1531
1333
|
# Use this parameter to prefill customer data if you already have an email
|
@@ -1533,177 +1335,136 @@ module Stripe
|
|
1533
1335
|
# complete, use the `customer` attribute.
|
1534
1336
|
sig { returns(T.nilable(String)) }
|
1535
1337
|
attr_reader :customer_email
|
1536
|
-
|
1537
1338
|
# The timestamp at which the Checkout Session will expire.
|
1538
1339
|
sig { returns(Integer) }
|
1539
1340
|
attr_reader :expires_at
|
1540
|
-
|
1541
1341
|
# Unique identifier for the object.
|
1542
1342
|
sig { returns(String) }
|
1543
1343
|
attr_reader :id
|
1544
|
-
|
1545
1344
|
# ID of the invoice created by the Checkout Session, if it exists.
|
1546
1345
|
sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
|
1547
1346
|
attr_reader :invoice
|
1548
|
-
|
1549
1347
|
# Details on the state of invoice creation for the Checkout Session.
|
1550
1348
|
sig { returns(T.nilable(InvoiceCreation)) }
|
1551
1349
|
attr_reader :invoice_creation
|
1552
|
-
|
1553
1350
|
# The line items purchased by the customer.
|
1554
1351
|
sig { returns(Stripe::ListObject) }
|
1555
1352
|
attr_reader :line_items
|
1556
|
-
|
1557
1353
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
1558
1354
|
sig { returns(T::Boolean) }
|
1559
1355
|
attr_reader :livemode
|
1560
|
-
|
1561
1356
|
# The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
|
1562
1357
|
sig { returns(T.nilable(String)) }
|
1563
1358
|
attr_reader :locale
|
1564
|
-
|
1565
1359
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
1566
1360
|
sig { returns(T.nilable(T::Hash[String, String])) }
|
1567
1361
|
attr_reader :metadata
|
1568
|
-
|
1569
1362
|
# The mode of the Checkout Session.
|
1570
1363
|
sig { returns(String) }
|
1571
1364
|
attr_reader :mode
|
1572
|
-
|
1573
1365
|
# String representing the object's type. Objects of the same type share the same value.
|
1574
1366
|
sig { returns(String) }
|
1575
1367
|
attr_reader :object
|
1576
|
-
|
1577
1368
|
# The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
|
1578
1369
|
sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
|
1579
1370
|
attr_reader :payment_intent
|
1580
|
-
|
1581
1371
|
# The ID of the Payment Link that created this Session.
|
1582
1372
|
sig { returns(T.nilable(T.any(String, Stripe::PaymentLink))) }
|
1583
1373
|
attr_reader :payment_link
|
1584
|
-
|
1585
1374
|
# Configure whether a Checkout Session should collect a payment method. Defaults to `always`.
|
1586
1375
|
sig { returns(T.nilable(String)) }
|
1587
1376
|
attr_reader :payment_method_collection
|
1588
|
-
|
1589
1377
|
# Information about the payment method configuration used for this Checkout session if using dynamic payment methods.
|
1590
1378
|
sig { returns(T.nilable(PaymentMethodConfigurationDetails)) }
|
1591
1379
|
attr_reader :payment_method_configuration_details
|
1592
|
-
|
1593
1380
|
# Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
|
1594
1381
|
sig { returns(T.nilable(PaymentMethodOptions)) }
|
1595
1382
|
attr_reader :payment_method_options
|
1596
|
-
|
1597
1383
|
# A list of the types of payment methods (e.g. card) this Checkout
|
1598
1384
|
# Session is allowed to accept.
|
1599
1385
|
sig { returns(T::Array[String]) }
|
1600
1386
|
attr_reader :payment_method_types
|
1601
|
-
|
1602
1387
|
# The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.
|
1603
1388
|
# You can use this value to decide when to fulfill your customer's order.
|
1604
1389
|
sig { returns(String) }
|
1605
1390
|
attr_reader :payment_status
|
1606
|
-
|
1607
1391
|
# This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
|
1608
1392
|
#
|
1609
1393
|
# For specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.
|
1610
1394
|
sig { returns(T.nilable(Permissions)) }
|
1611
1395
|
attr_reader :permissions
|
1612
|
-
|
1613
1396
|
# Attribute for field phone_number_collection
|
1614
1397
|
sig { returns(PhoneNumberCollection) }
|
1615
1398
|
attr_reader :phone_number_collection
|
1616
|
-
|
1617
1399
|
# The ID of the original expired Checkout Session that triggered the recovery flow.
|
1618
1400
|
sig { returns(T.nilable(String)) }
|
1619
1401
|
attr_reader :recovered_from
|
1620
|
-
|
1621
1402
|
# This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
|
1622
1403
|
sig { returns(String) }
|
1623
1404
|
attr_reader :redirect_on_completion
|
1624
|
-
|
1625
1405
|
# Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
|
1626
1406
|
sig { returns(String) }
|
1627
1407
|
attr_reader :return_url
|
1628
|
-
|
1629
1408
|
# Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
|
1630
1409
|
sig { returns(T.nilable(SavedPaymentMethodOptions)) }
|
1631
1410
|
attr_reader :saved_payment_method_options
|
1632
|
-
|
1633
1411
|
# The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
|
1634
1412
|
sig { returns(T.nilable(T.any(String, Stripe::SetupIntent))) }
|
1635
1413
|
attr_reader :setup_intent
|
1636
|
-
|
1637
1414
|
# When set, provides configuration for Checkout to collect a shipping address from a customer.
|
1638
1415
|
sig { returns(T.nilable(ShippingAddressCollection)) }
|
1639
1416
|
attr_reader :shipping_address_collection
|
1640
|
-
|
1641
1417
|
# The details of the customer cost of shipping, including the customer chosen ShippingRate.
|
1642
1418
|
sig { returns(T.nilable(ShippingCost)) }
|
1643
1419
|
attr_reader :shipping_cost
|
1644
|
-
|
1645
1420
|
# Shipping information for this Checkout Session.
|
1646
1421
|
sig { returns(T.nilable(ShippingDetails)) }
|
1647
1422
|
attr_reader :shipping_details
|
1648
|
-
|
1649
1423
|
# The shipping rate options applied to this Session.
|
1650
1424
|
sig { returns(T::Array[ShippingOption]) }
|
1651
1425
|
attr_reader :shipping_options
|
1652
|
-
|
1653
1426
|
# The status of the Checkout Session, one of `open`, `complete`, or `expired`.
|
1654
1427
|
sig { returns(T.nilable(String)) }
|
1655
1428
|
attr_reader :status
|
1656
|
-
|
1657
1429
|
# Describes the type of transaction being performed by Checkout in order to customize
|
1658
1430
|
# relevant text on the page, such as the submit button. `submit_type` can only be
|
1659
1431
|
# specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
|
1660
1432
|
sig { returns(T.nilable(String)) }
|
1661
1433
|
attr_reader :submit_type
|
1662
|
-
|
1663
1434
|
# The ID of the subscription for Checkout Sessions in `subscription` mode.
|
1664
1435
|
sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
|
1665
1436
|
attr_reader :subscription
|
1666
|
-
|
1667
1437
|
# The URL the customer will be directed to after the payment or
|
1668
1438
|
# subscription creation is successful.
|
1669
1439
|
sig { returns(T.nilable(String)) }
|
1670
1440
|
attr_reader :success_url
|
1671
|
-
|
1672
1441
|
# Attribute for field tax_id_collection
|
1673
1442
|
sig { returns(TaxIdCollection) }
|
1674
1443
|
attr_reader :tax_id_collection
|
1675
|
-
|
1676
1444
|
# Tax and discount details for the computed total amount.
|
1677
1445
|
sig { returns(T.nilable(TotalDetails)) }
|
1678
1446
|
attr_reader :total_details
|
1679
|
-
|
1680
1447
|
# The UI mode of the Session. Defaults to `hosted`.
|
1681
1448
|
sig { returns(T.nilable(String)) }
|
1682
1449
|
attr_reader :ui_mode
|
1683
|
-
|
1684
1450
|
# The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`
|
1685
1451
|
# This value is only present when the session is active.
|
1686
1452
|
sig { returns(T.nilable(String)) }
|
1687
1453
|
attr_reader :url
|
1688
|
-
|
1689
1454
|
class ListParams < Stripe::RequestParams
|
1690
1455
|
class Created < Stripe::RequestParams
|
1691
1456
|
# Minimum value to filter by (exclusive)
|
1692
1457
|
sig { returns(Integer) }
|
1693
1458
|
attr_accessor :gt
|
1694
|
-
|
1695
1459
|
# Minimum value to filter by (inclusive)
|
1696
1460
|
sig { returns(Integer) }
|
1697
1461
|
attr_accessor :gte
|
1698
|
-
|
1699
1462
|
# Maximum value to filter by (exclusive)
|
1700
1463
|
sig { returns(Integer) }
|
1701
1464
|
attr_accessor :lt
|
1702
|
-
|
1703
1465
|
# Maximum value to filter by (inclusive)
|
1704
1466
|
sig { returns(Integer) }
|
1705
1467
|
attr_accessor :lte
|
1706
|
-
|
1707
1468
|
sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
|
1708
1469
|
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
|
1709
1470
|
end
|
@@ -1711,54 +1472,42 @@ module Stripe
|
|
1711
1472
|
# Customer's email address.
|
1712
1473
|
sig { returns(String) }
|
1713
1474
|
attr_accessor :email
|
1714
|
-
|
1715
1475
|
sig { params(email: String).void }
|
1716
1476
|
def initialize(email: nil); end
|
1717
1477
|
end
|
1718
1478
|
# Only return Checkout Sessions that were created during the given date interval.
|
1719
1479
|
sig { returns(T.any(::Stripe::Checkout::Session::ListParams::Created, Integer)) }
|
1720
1480
|
attr_accessor :created
|
1721
|
-
|
1722
1481
|
# Only return the Checkout Sessions for the Customer specified.
|
1723
1482
|
sig { returns(String) }
|
1724
1483
|
attr_accessor :customer
|
1725
|
-
|
1726
1484
|
# Only return the Checkout Sessions for the Customer details specified.
|
1727
1485
|
sig { returns(::Stripe::Checkout::Session::ListParams::CustomerDetails) }
|
1728
1486
|
attr_accessor :customer_details
|
1729
|
-
|
1730
1487
|
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
1731
1488
|
sig { returns(String) }
|
1732
1489
|
attr_accessor :ending_before
|
1733
|
-
|
1734
1490
|
# Specifies which fields in the response should be expanded.
|
1735
1491
|
sig { returns(T::Array[String]) }
|
1736
1492
|
attr_accessor :expand
|
1737
|
-
|
1738
1493
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
1739
1494
|
sig { returns(Integer) }
|
1740
1495
|
attr_accessor :limit
|
1741
|
-
|
1742
1496
|
# Only return the Checkout Session for the PaymentIntent specified.
|
1743
1497
|
sig { returns(String) }
|
1744
1498
|
attr_accessor :payment_intent
|
1745
|
-
|
1746
1499
|
# Only return the Checkout Sessions for the Payment Link specified.
|
1747
1500
|
sig { returns(String) }
|
1748
1501
|
attr_accessor :payment_link
|
1749
|
-
|
1750
1502
|
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
1751
1503
|
sig { returns(String) }
|
1752
1504
|
attr_accessor :starting_after
|
1753
|
-
|
1754
1505
|
# Only return the Checkout Sessions matching the given status.
|
1755
1506
|
sig { returns(String) }
|
1756
1507
|
attr_accessor :status
|
1757
|
-
|
1758
1508
|
# Only return the Checkout Session for the subscription specified.
|
1759
1509
|
sig { returns(String) }
|
1760
1510
|
attr_accessor :subscription
|
1761
|
-
|
1762
1511
|
sig {
|
1763
1512
|
params(created: T.any(::Stripe::Checkout::Session::ListParams::Created, Integer), customer: String, customer_details: ::Stripe::Checkout::Session::ListParams::CustomerDetails, ending_before: String, expand: T::Array[String], limit: Integer, payment_intent: String, payment_link: String, starting_after: String, status: String, subscription: String).void
|
1764
1513
|
}
|
@@ -1781,7 +1530,6 @@ module Stripe
|
|
1781
1530
|
# Set to `true` to enable [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing).
|
1782
1531
|
sig { returns(T::Boolean) }
|
1783
1532
|
attr_accessor :enabled
|
1784
|
-
|
1785
1533
|
sig { params(enabled: T::Boolean).void }
|
1786
1534
|
def initialize(enabled: nil); end
|
1787
1535
|
end
|
@@ -1790,20 +1538,17 @@ module Stripe
|
|
1790
1538
|
# Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
|
1791
1539
|
sig { returns(T::Boolean) }
|
1792
1540
|
attr_accessor :allow_promotion_codes
|
1793
|
-
|
1794
1541
|
# If `true`, a recovery URL will be generated to recover this Checkout Session if it
|
1795
1542
|
# expires before a successful transaction is completed. It will be attached to the
|
1796
1543
|
# Checkout Session object upon expiration.
|
1797
1544
|
sig { returns(T::Boolean) }
|
1798
1545
|
attr_accessor :enabled
|
1799
|
-
|
1800
1546
|
sig { params(allow_promotion_codes: T::Boolean, enabled: T::Boolean).void }
|
1801
1547
|
def initialize(allow_promotion_codes: nil, enabled: nil); end
|
1802
1548
|
end
|
1803
1549
|
# Configure a Checkout Session that can be used to recover an expired session.
|
1804
1550
|
sig { returns(::Stripe::Checkout::Session::CreateParams::AfterExpiration::Recovery) }
|
1805
1551
|
attr_accessor :recovery
|
1806
|
-
|
1807
1552
|
sig {
|
1808
1553
|
params(recovery: ::Stripe::Checkout::Session::CreateParams::AfterExpiration::Recovery).void
|
1809
1554
|
}
|
@@ -1814,11 +1559,9 @@ module Stripe
|
|
1814
1559
|
# The connected account being referenced when `type` is `account`.
|
1815
1560
|
sig { returns(String) }
|
1816
1561
|
attr_accessor :account
|
1817
|
-
|
1818
1562
|
# Type of the account referenced in the request.
|
1819
1563
|
sig { returns(String) }
|
1820
1564
|
attr_accessor :type
|
1821
|
-
|
1822
1565
|
sig { params(account: String, type: String).void }
|
1823
1566
|
def initialize(account: nil, type: nil); end
|
1824
1567
|
end
|
@@ -1827,11 +1570,9 @@ module Stripe
|
|
1827
1570
|
# Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.
|
1828
1571
|
sig { returns(T::Boolean) }
|
1829
1572
|
attr_accessor :enabled
|
1830
|
-
|
1831
1573
|
# 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.
|
1832
1574
|
sig { returns(::Stripe::Checkout::Session::CreateParams::AutomaticTax::Liability) }
|
1833
1575
|
attr_accessor :liability
|
1834
|
-
|
1835
1576
|
sig {
|
1836
1577
|
params(enabled: T::Boolean, liability: ::Stripe::Checkout::Session::CreateParams::AutomaticTax::Liability).void
|
1837
1578
|
}
|
@@ -1843,7 +1584,6 @@ module Stripe
|
|
1843
1584
|
# defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
|
1844
1585
|
sig { returns(String) }
|
1845
1586
|
attr_accessor :position
|
1846
|
-
|
1847
1587
|
sig { params(position: String).void }
|
1848
1588
|
def initialize(position: nil); end
|
1849
1589
|
end
|
@@ -1852,18 +1592,15 @@ module Stripe
|
|
1852
1592
|
returns(::Stripe::Checkout::Session::CreateParams::ConsentCollection::PaymentMethodReuseAgreement)
|
1853
1593
|
}
|
1854
1594
|
attr_accessor :payment_method_reuse_agreement
|
1855
|
-
|
1856
1595
|
# If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
|
1857
1596
|
# Session will determine whether to display an option to opt into promotional communication
|
1858
1597
|
# from the merchant depending on the customer's locale. Only available to US merchants.
|
1859
1598
|
sig { returns(String) }
|
1860
1599
|
attr_accessor :promotions
|
1861
|
-
|
1862
1600
|
# If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
|
1863
1601
|
# There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
|
1864
1602
|
sig { returns(String) }
|
1865
1603
|
attr_accessor :terms_of_service
|
1866
|
-
|
1867
1604
|
sig {
|
1868
1605
|
params(payment_method_reuse_agreement: ::Stripe::Checkout::Session::CreateParams::ConsentCollection::PaymentMethodReuseAgreement, promotions: String, terms_of_service: String).void
|
1869
1606
|
}
|
@@ -1879,24 +1616,20 @@ module Stripe
|
|
1879
1616
|
# The label for the option, displayed to the customer. Up to 100 characters.
|
1880
1617
|
sig { returns(String) }
|
1881
1618
|
attr_accessor :label
|
1882
|
-
|
1883
1619
|
# The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
|
1884
1620
|
sig { returns(String) }
|
1885
1621
|
attr_accessor :value
|
1886
|
-
|
1887
1622
|
sig { params(label: String, value: String).void }
|
1888
1623
|
def initialize(label: nil, value: nil); end
|
1889
1624
|
end
|
1890
1625
|
# The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
|
1891
1626
|
sig { returns(String) }
|
1892
1627
|
attr_accessor :default_value
|
1893
|
-
|
1894
1628
|
# The options available for the customer to select. Up to 200 options allowed.
|
1895
1629
|
sig {
|
1896
1630
|
returns(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown::Option])
|
1897
1631
|
}
|
1898
1632
|
attr_accessor :options
|
1899
|
-
|
1900
1633
|
sig {
|
1901
1634
|
params(default_value: String, options: T::Array[::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown::Option]).void
|
1902
1635
|
}
|
@@ -1906,11 +1639,9 @@ module Stripe
|
|
1906
1639
|
# Custom text for the label, displayed to the customer. Up to 50 characters.
|
1907
1640
|
sig { returns(String) }
|
1908
1641
|
attr_accessor :custom
|
1909
|
-
|
1910
1642
|
# The type of the label.
|
1911
1643
|
sig { returns(String) }
|
1912
1644
|
attr_accessor :type
|
1913
|
-
|
1914
1645
|
sig { params(custom: String, type: String).void }
|
1915
1646
|
def initialize(custom: nil, type: nil); end
|
1916
1647
|
end
|
@@ -1918,15 +1649,12 @@ module Stripe
|
|
1918
1649
|
# The value that will pre-fill the field on the payment page.
|
1919
1650
|
sig { returns(String) }
|
1920
1651
|
attr_accessor :default_value
|
1921
|
-
|
1922
1652
|
# The maximum character length constraint for the customer's input.
|
1923
1653
|
sig { returns(Integer) }
|
1924
1654
|
attr_accessor :maximum_length
|
1925
|
-
|
1926
1655
|
# The minimum character length requirement for the customer's input.
|
1927
1656
|
sig { returns(Integer) }
|
1928
1657
|
attr_accessor :minimum_length
|
1929
|
-
|
1930
1658
|
sig {
|
1931
1659
|
params(default_value: String, maximum_length: Integer, minimum_length: Integer).void
|
1932
1660
|
}
|
@@ -1936,15 +1664,12 @@ module Stripe
|
|
1936
1664
|
# The value that will pre-fill the field on the payment page.
|
1937
1665
|
sig { returns(String) }
|
1938
1666
|
attr_accessor :default_value
|
1939
|
-
|
1940
1667
|
# The maximum character length constraint for the customer's input.
|
1941
1668
|
sig { returns(Integer) }
|
1942
1669
|
attr_accessor :maximum_length
|
1943
|
-
|
1944
1670
|
# The minimum character length requirement for the customer's input.
|
1945
1671
|
sig { returns(Integer) }
|
1946
1672
|
attr_accessor :minimum_length
|
1947
|
-
|
1948
1673
|
sig {
|
1949
1674
|
params(default_value: String, maximum_length: Integer, minimum_length: Integer).void
|
1950
1675
|
}
|
@@ -1953,31 +1678,24 @@ module Stripe
|
|
1953
1678
|
# Configuration for `type=dropdown` fields.
|
1954
1679
|
sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown) }
|
1955
1680
|
attr_accessor :dropdown
|
1956
|
-
|
1957
1681
|
# String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
|
1958
1682
|
sig { returns(String) }
|
1959
1683
|
attr_accessor :key
|
1960
|
-
|
1961
1684
|
# The label for the field, displayed to the customer.
|
1962
1685
|
sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Label) }
|
1963
1686
|
attr_accessor :label
|
1964
|
-
|
1965
1687
|
# Configuration for `type=numeric` fields.
|
1966
1688
|
sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Numeric) }
|
1967
1689
|
attr_accessor :numeric
|
1968
|
-
|
1969
1690
|
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
|
1970
1691
|
sig { returns(T::Boolean) }
|
1971
1692
|
attr_accessor :optional
|
1972
|
-
|
1973
1693
|
# Configuration for `type=text` fields.
|
1974
1694
|
sig { returns(::Stripe::Checkout::Session::CreateParams::CustomField::Text) }
|
1975
1695
|
attr_accessor :text
|
1976
|
-
|
1977
1696
|
# The type of the field.
|
1978
1697
|
sig { returns(String) }
|
1979
1698
|
attr_accessor :type
|
1980
|
-
|
1981
1699
|
sig {
|
1982
1700
|
params(dropdown: ::Stripe::Checkout::Session::CreateParams::CustomField::Dropdown, key: String, label: ::Stripe::Checkout::Session::CreateParams::CustomField::Label, numeric: ::Stripe::Checkout::Session::CreateParams::CustomField::Numeric, optional: T::Boolean, text: ::Stripe::Checkout::Session::CreateParams::CustomField::Text, type: String).void
|
1983
1701
|
}
|
@@ -1996,7 +1714,6 @@ module Stripe
|
|
1996
1714
|
# Text may be up to 1200 characters in length.
|
1997
1715
|
sig { returns(String) }
|
1998
1716
|
attr_accessor :message
|
1999
|
-
|
2000
1717
|
sig { params(message: String).void }
|
2001
1718
|
def initialize(message: nil); end
|
2002
1719
|
end
|
@@ -2004,7 +1721,6 @@ module Stripe
|
|
2004
1721
|
# Text may be up to 1200 characters in length.
|
2005
1722
|
sig { returns(String) }
|
2006
1723
|
attr_accessor :message
|
2007
|
-
|
2008
1724
|
sig { params(message: String).void }
|
2009
1725
|
def initialize(message: nil); end
|
2010
1726
|
end
|
@@ -2012,7 +1728,6 @@ module Stripe
|
|
2012
1728
|
# Text may be up to 1200 characters in length.
|
2013
1729
|
sig { returns(String) }
|
2014
1730
|
attr_accessor :message
|
2015
|
-
|
2016
1731
|
sig { params(message: String).void }
|
2017
1732
|
def initialize(message: nil); end
|
2018
1733
|
end
|
@@ -2020,7 +1735,6 @@ module Stripe
|
|
2020
1735
|
# Text may be up to 1200 characters in length.
|
2021
1736
|
sig { returns(String) }
|
2022
1737
|
attr_accessor :message
|
2023
|
-
|
2024
1738
|
sig { params(message: String).void }
|
2025
1739
|
def initialize(message: nil); end
|
2026
1740
|
end
|
@@ -2029,23 +1743,19 @@ module Stripe
|
|
2029
1743
|
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::AfterSubmit))
|
2030
1744
|
}
|
2031
1745
|
attr_accessor :after_submit
|
2032
|
-
|
2033
1746
|
# Custom text that should be displayed alongside shipping address collection.
|
2034
1747
|
sig {
|
2035
1748
|
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::ShippingAddress))
|
2036
1749
|
}
|
2037
1750
|
attr_accessor :shipping_address
|
2038
|
-
|
2039
1751
|
# Custom text that should be displayed alongside the payment confirmation button.
|
2040
1752
|
sig { returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::Submit)) }
|
2041
1753
|
attr_accessor :submit
|
2042
|
-
|
2043
1754
|
# Custom text that should be displayed in place of the default terms of service agreement text.
|
2044
1755
|
sig {
|
2045
1756
|
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::TermsOfServiceAcceptance))
|
2046
1757
|
}
|
2047
1758
|
attr_accessor :terms_of_service_acceptance
|
2048
|
-
|
2049
1759
|
sig {
|
2050
1760
|
params(after_submit: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::AfterSubmit), shipping_address: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::ShippingAddress), submit: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::Submit), terms_of_service_acceptance: T.nilable(::Stripe::Checkout::Session::CreateParams::CustomText::TermsOfServiceAcceptance)).void
|
2051
1761
|
}
|
@@ -2061,16 +1771,13 @@ module Stripe
|
|
2061
1771
|
# To always collect a full billing address, use `billing_address_collection`. Defaults to `never`.
|
2062
1772
|
sig { returns(String) }
|
2063
1773
|
attr_accessor :address
|
2064
|
-
|
2065
1774
|
# Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.
|
2066
1775
|
sig { returns(String) }
|
2067
1776
|
attr_accessor :name
|
2068
|
-
|
2069
1777
|
# Describes whether Checkout saves shipping information onto `customer.shipping`.
|
2070
1778
|
# To collect shipping information, use `shipping_address_collection`. Defaults to `never`.
|
2071
1779
|
sig { returns(String) }
|
2072
1780
|
attr_accessor :shipping
|
2073
|
-
|
2074
1781
|
sig { params(address: String, name: String, shipping: String).void }
|
2075
1782
|
def initialize(address: nil, name: nil, shipping: nil); end
|
2076
1783
|
end
|
@@ -2078,11 +1785,9 @@ module Stripe
|
|
2078
1785
|
# The ID of the coupon to apply to this Session.
|
2079
1786
|
sig { returns(String) }
|
2080
1787
|
attr_accessor :coupon
|
2081
|
-
|
2082
1788
|
# The ID of a promotion code to apply to this Session.
|
2083
1789
|
sig { returns(String) }
|
2084
1790
|
attr_accessor :promotion_code
|
2085
|
-
|
2086
1791
|
sig { params(coupon: String, promotion_code: String).void }
|
2087
1792
|
def initialize(coupon: nil, promotion_code: nil); end
|
2088
1793
|
end
|
@@ -2092,11 +1797,9 @@ module Stripe
|
|
2092
1797
|
# The name of the custom field. This may be up to 40 characters.
|
2093
1798
|
sig { returns(String) }
|
2094
1799
|
attr_accessor :name
|
2095
|
-
|
2096
1800
|
# The value of the custom field. This may be up to 140 characters.
|
2097
1801
|
sig { returns(String) }
|
2098
1802
|
attr_accessor :value
|
2099
|
-
|
2100
1803
|
sig { params(name: String, value: String).void }
|
2101
1804
|
def initialize(name: nil, value: nil); end
|
2102
1805
|
end
|
@@ -2104,11 +1807,9 @@ module Stripe
|
|
2104
1807
|
# The connected account being referenced when `type` is `account`.
|
2105
1808
|
sig { returns(String) }
|
2106
1809
|
attr_accessor :account
|
2107
|
-
|
2108
1810
|
# Type of the account referenced in the request.
|
2109
1811
|
sig { returns(String) }
|
2110
1812
|
attr_accessor :type
|
2111
|
-
|
2112
1813
|
sig { params(account: String, type: String).void }
|
2113
1814
|
def initialize(account: nil, type: nil); end
|
2114
1815
|
end
|
@@ -2116,44 +1817,36 @@ module Stripe
|
|
2116
1817
|
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
|
2117
1818
|
sig { returns(T.nilable(String)) }
|
2118
1819
|
attr_accessor :amount_tax_display
|
2119
|
-
|
2120
1820
|
sig { params(amount_tax_display: T.nilable(String)).void }
|
2121
1821
|
def initialize(amount_tax_display: nil); end
|
2122
1822
|
end
|
2123
1823
|
# The account tax IDs associated with the invoice.
|
2124
1824
|
sig { returns(T.nilable(T::Array[String])) }
|
2125
1825
|
attr_accessor :account_tax_ids
|
2126
|
-
|
2127
1826
|
# Default custom fields to be displayed on invoices for this customer.
|
2128
1827
|
sig {
|
2129
1828
|
returns(T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::CustomField]))
|
2130
1829
|
}
|
2131
1830
|
attr_accessor :custom_fields
|
2132
|
-
|
2133
1831
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
2134
1832
|
sig { returns(String) }
|
2135
1833
|
attr_accessor :description
|
2136
|
-
|
2137
1834
|
# Default footer to be displayed on invoices for this customer.
|
2138
1835
|
sig { returns(String) }
|
2139
1836
|
attr_accessor :footer
|
2140
|
-
|
2141
1837
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
2142
1838
|
sig {
|
2143
1839
|
returns(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::Issuer)
|
2144
1840
|
}
|
2145
1841
|
attr_accessor :issuer
|
2146
|
-
|
2147
1842
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
2148
1843
|
sig { returns(T::Hash[String, String]) }
|
2149
1844
|
attr_accessor :metadata
|
2150
|
-
|
2151
1845
|
# Default options for invoice PDF rendering for this customer.
|
2152
1846
|
sig {
|
2153
1847
|
returns(T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))
|
2154
1848
|
}
|
2155
1849
|
attr_accessor :rendering_options
|
2156
|
-
|
2157
1850
|
sig {
|
2158
1851
|
params(account_tax_ids: T.nilable(T::Array[String]), custom_fields: T.nilable(T::Array[::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::CustomField]), description: String, footer: String, issuer: ::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::Issuer, metadata: T::Hash[String, String], rendering_options: T.nilable(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)).void
|
2159
1852
|
}
|
@@ -2170,11 +1863,9 @@ module Stripe
|
|
2170
1863
|
# Set to `true` to enable invoice creation.
|
2171
1864
|
sig { returns(T::Boolean) }
|
2172
1865
|
attr_accessor :enabled
|
2173
|
-
|
2174
1866
|
# Parameters passed when creating invoices for payment-mode Checkout Sessions.
|
2175
1867
|
sig { returns(::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData) }
|
2176
1868
|
attr_accessor :invoice_data
|
2177
|
-
|
2178
1869
|
sig {
|
2179
1870
|
params(enabled: T::Boolean, invoice_data: ::Stripe::Checkout::Session::CreateParams::InvoiceCreation::InvoiceData).void
|
2180
1871
|
}
|
@@ -2185,15 +1876,12 @@ module Stripe
|
|
2185
1876
|
# Set to true if the quantity can be adjusted to any non-negative integer.
|
2186
1877
|
sig { returns(T::Boolean) }
|
2187
1878
|
attr_accessor :enabled
|
2188
|
-
|
2189
1879
|
# The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
|
2190
1880
|
sig { returns(Integer) }
|
2191
1881
|
attr_accessor :maximum
|
2192
|
-
|
2193
1882
|
# The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
|
2194
1883
|
sig { returns(Integer) }
|
2195
1884
|
attr_accessor :minimum
|
2196
|
-
|
2197
1885
|
sig { params(enabled: T::Boolean, maximum: Integer, minimum: Integer).void }
|
2198
1886
|
def initialize(enabled: nil, maximum: nil, minimum: nil); end
|
2199
1887
|
end
|
@@ -2202,23 +1890,18 @@ module Stripe
|
|
2202
1890
|
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
|
2203
1891
|
sig { returns(String) }
|
2204
1892
|
attr_accessor :description
|
2205
|
-
|
2206
1893
|
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
2207
1894
|
sig { returns(T::Array[String]) }
|
2208
1895
|
attr_accessor :images
|
2209
|
-
|
2210
1896
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
2211
1897
|
sig { returns(T::Hash[String, String]) }
|
2212
1898
|
attr_accessor :metadata
|
2213
|
-
|
2214
1899
|
# The product's name, meant to be displayable to the customer.
|
2215
1900
|
sig { returns(String) }
|
2216
1901
|
attr_accessor :name
|
2217
|
-
|
2218
1902
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
|
2219
1903
|
sig { returns(String) }
|
2220
1904
|
attr_accessor :tax_code
|
2221
|
-
|
2222
1905
|
sig {
|
2223
1906
|
params(description: String, images: T::Array[String], metadata: T::Hash[String, String], name: String, tax_code: String).void
|
2224
1907
|
}
|
@@ -2234,46 +1917,37 @@ module Stripe
|
|
2234
1917
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
2235
1918
|
sig { returns(String) }
|
2236
1919
|
attr_accessor :interval
|
2237
|
-
|
2238
1920
|
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
2239
1921
|
sig { returns(Integer) }
|
2240
1922
|
attr_accessor :interval_count
|
2241
|
-
|
2242
1923
|
sig { params(interval: String, interval_count: Integer).void }
|
2243
1924
|
def initialize(interval: nil, interval_count: nil); end
|
2244
1925
|
end
|
2245
1926
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
2246
1927
|
sig { returns(String) }
|
2247
1928
|
attr_accessor :currency
|
2248
|
-
|
2249
1929
|
# The ID of the product that this price will belong to. One of `product` or `product_data` is required.
|
2250
1930
|
sig { returns(String) }
|
2251
1931
|
attr_accessor :product
|
2252
|
-
|
2253
1932
|
# Data used to generate a new product object inline. One of `product` or `product_data` is required.
|
2254
1933
|
sig {
|
2255
1934
|
returns(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::ProductData)
|
2256
1935
|
}
|
2257
1936
|
attr_accessor :product_data
|
2258
|
-
|
2259
1937
|
# The recurring components of a price such as `interval` and `interval_count`.
|
2260
1938
|
sig {
|
2261
1939
|
returns(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::Recurring)
|
2262
1940
|
}
|
2263
1941
|
attr_accessor :recurring
|
2264
|
-
|
2265
1942
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
2266
1943
|
sig { returns(String) }
|
2267
1944
|
attr_accessor :tax_behavior
|
2268
|
-
|
2269
1945
|
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
|
2270
1946
|
sig { returns(Integer) }
|
2271
1947
|
attr_accessor :unit_amount
|
2272
|
-
|
2273
1948
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
2274
1949
|
sig { returns(String) }
|
2275
1950
|
attr_accessor :unit_amount_decimal
|
2276
|
-
|
2277
1951
|
sig {
|
2278
1952
|
params(currency: String, product: String, product_data: ::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::ProductData, recurring: ::Stripe::Checkout::Session::CreateParams::LineItem::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
|
2279
1953
|
}
|
@@ -2290,31 +1964,24 @@ module Stripe
|
|
2290
1964
|
# When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
|
2291
1965
|
sig { returns(::Stripe::Checkout::Session::CreateParams::LineItem::AdjustableQuantity) }
|
2292
1966
|
attr_accessor :adjustable_quantity
|
2293
|
-
|
2294
1967
|
# The [tax rates](https://stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.
|
2295
1968
|
sig { returns(T::Array[String]) }
|
2296
1969
|
attr_accessor :dynamic_tax_rates
|
2297
|
-
|
2298
1970
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
2299
1971
|
sig { returns(T::Hash[String, String]) }
|
2300
1972
|
attr_accessor :metadata
|
2301
|
-
|
2302
1973
|
# The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.
|
2303
1974
|
sig { returns(String) }
|
2304
1975
|
attr_accessor :price
|
2305
|
-
|
2306
1976
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
2307
1977
|
sig { returns(::Stripe::Checkout::Session::CreateParams::LineItem::PriceData) }
|
2308
1978
|
attr_accessor :price_data
|
2309
|
-
|
2310
1979
|
# The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
|
2311
1980
|
sig { returns(Integer) }
|
2312
1981
|
attr_accessor :quantity
|
2313
|
-
|
2314
1982
|
# The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
|
2315
1983
|
sig { returns(T::Array[String]) }
|
2316
1984
|
attr_accessor :tax_rates
|
2317
|
-
|
2318
1985
|
sig {
|
2319
1986
|
params(adjustable_quantity: ::Stripe::Checkout::Session::CreateParams::LineItem::AdjustableQuantity, dynamic_tax_rates: T::Array[String], metadata: T::Hash[String, String], price: String, price_data: ::Stripe::Checkout::Session::CreateParams::LineItem::PriceData, quantity: Integer, tax_rates: T::Array[String]).void
|
2320
1987
|
}
|
@@ -2334,27 +2001,21 @@ module Stripe
|
|
2334
2001
|
# City, district, suburb, town, or village.
|
2335
2002
|
sig { returns(String) }
|
2336
2003
|
attr_accessor :city
|
2337
|
-
|
2338
2004
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
2339
2005
|
sig { returns(String) }
|
2340
2006
|
attr_accessor :country
|
2341
|
-
|
2342
2007
|
# Address line 1 (e.g., street, PO Box, or company name).
|
2343
2008
|
sig { returns(String) }
|
2344
2009
|
attr_accessor :line1
|
2345
|
-
|
2346
2010
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
2347
2011
|
sig { returns(String) }
|
2348
2012
|
attr_accessor :line2
|
2349
|
-
|
2350
2013
|
# ZIP or postal code.
|
2351
2014
|
sig { returns(String) }
|
2352
2015
|
attr_accessor :postal_code
|
2353
|
-
|
2354
2016
|
# State, county, province, or region.
|
2355
2017
|
sig { returns(String) }
|
2356
2018
|
attr_accessor :state
|
2357
|
-
|
2358
2019
|
sig {
|
2359
2020
|
params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
|
2360
2021
|
}
|
@@ -2372,23 +2033,18 @@ module Stripe
|
|
2372
2033
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping::Address)
|
2373
2034
|
}
|
2374
2035
|
attr_accessor :address
|
2375
|
-
|
2376
2036
|
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
|
2377
2037
|
sig { returns(String) }
|
2378
2038
|
attr_accessor :carrier
|
2379
|
-
|
2380
2039
|
# Recipient name.
|
2381
2040
|
sig { returns(String) }
|
2382
2041
|
attr_accessor :name
|
2383
|
-
|
2384
2042
|
# Recipient phone (including extension).
|
2385
2043
|
sig { returns(String) }
|
2386
2044
|
attr_accessor :phone
|
2387
|
-
|
2388
2045
|
# The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
|
2389
2046
|
sig { returns(String) }
|
2390
2047
|
attr_accessor :tracking_number
|
2391
|
-
|
2392
2048
|
sig {
|
2393
2049
|
params(address: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping::Address, carrier: String, name: String, phone: String, tracking_number: String).void
|
2394
2050
|
}
|
@@ -2404,43 +2060,35 @@ module Stripe
|
|
2404
2060
|
# The amount that will be transferred automatically when a charge succeeds.
|
2405
2061
|
sig { returns(Integer) }
|
2406
2062
|
attr_accessor :amount
|
2407
|
-
|
2408
2063
|
# If specified, successful charges will be attributed to the destination
|
2409
2064
|
# account for tax reporting, and the funds from charges will be transferred
|
2410
2065
|
# to the destination account. The ID of the resulting transfer will be
|
2411
2066
|
# returned on the successful charge's `transfer` field.
|
2412
2067
|
sig { returns(String) }
|
2413
2068
|
attr_accessor :destination
|
2414
|
-
|
2415
2069
|
sig { params(amount: Integer, destination: String).void }
|
2416
2070
|
def initialize(amount: nil, destination: nil); end
|
2417
2071
|
end
|
2418
2072
|
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
|
2419
2073
|
sig { returns(Integer) }
|
2420
2074
|
attr_accessor :application_fee_amount
|
2421
|
-
|
2422
2075
|
# Controls when the funds will be captured from the customer's account.
|
2423
2076
|
sig { returns(String) }
|
2424
2077
|
attr_accessor :capture_method
|
2425
|
-
|
2426
2078
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
2427
2079
|
sig { returns(String) }
|
2428
2080
|
attr_accessor :description
|
2429
|
-
|
2430
2081
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
2431
2082
|
sig { returns(T::Hash[String, String]) }
|
2432
2083
|
attr_accessor :metadata
|
2433
|
-
|
2434
2084
|
# The Stripe account ID for which these funds are intended. For details,
|
2435
2085
|
# see the PaymentIntents [use case for connected
|
2436
2086
|
# accounts](/docs/payments/connected-accounts).
|
2437
2087
|
sig { returns(String) }
|
2438
2088
|
attr_accessor :on_behalf_of
|
2439
|
-
|
2440
2089
|
# Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
|
2441
2090
|
sig { returns(String) }
|
2442
2091
|
attr_accessor :receipt_email
|
2443
|
-
|
2444
2092
|
# Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment
|
2445
2093
|
# method collected by this Checkout Session.
|
2446
2094
|
#
|
@@ -2463,32 +2111,26 @@ module Stripe
|
|
2463
2111
|
# legislation and network rules, such as SCA.
|
2464
2112
|
sig { returns(String) }
|
2465
2113
|
attr_accessor :setup_future_usage
|
2466
|
-
|
2467
2114
|
# Shipping information for this payment.
|
2468
2115
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping) }
|
2469
2116
|
attr_accessor :shipping
|
2470
|
-
|
2471
2117
|
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
|
2472
2118
|
#
|
2473
2119
|
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
|
2474
2120
|
sig { returns(String) }
|
2475
2121
|
attr_accessor :statement_descriptor
|
2476
|
-
|
2477
2122
|
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
|
2478
2123
|
sig { returns(String) }
|
2479
2124
|
attr_accessor :statement_descriptor_suffix
|
2480
|
-
|
2481
2125
|
# The parameters used to automatically create a Transfer when the payment succeeds.
|
2482
2126
|
# For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
|
2483
2127
|
sig {
|
2484
2128
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData::TransferData)
|
2485
2129
|
}
|
2486
2130
|
attr_accessor :transfer_data
|
2487
|
-
|
2488
2131
|
# A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
|
2489
2132
|
sig { returns(String) }
|
2490
2133
|
attr_accessor :transfer_group
|
2491
|
-
|
2492
2134
|
sig {
|
2493
2135
|
params(application_fee_amount: Integer, capture_method: String, description: String, metadata: T::Hash[String, String], on_behalf_of: String, receipt_email: String, setup_future_usage: String, shipping: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData::Shipping, statement_descriptor: String, statement_descriptor_suffix: String, transfer_data: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData::TransferData, transfer_group: String).void
|
2494
2136
|
}
|
@@ -2511,7 +2153,6 @@ module Stripe
|
|
2511
2153
|
# Allow redisplay will be set on the payment method on confirmation and indicates whether this payment method can be shown again to the customer in a checkout flow. Only set this field if you wish to override the allow_redisplay value determined by Checkout.
|
2512
2154
|
sig { returns(String) }
|
2513
2155
|
attr_accessor :allow_redisplay
|
2514
|
-
|
2515
2156
|
sig { params(allow_redisplay: String).void }
|
2516
2157
|
def initialize(allow_redisplay: nil); end
|
2517
2158
|
end
|
@@ -2523,23 +2164,18 @@ module Stripe
|
|
2523
2164
|
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
|
2524
2165
|
sig { returns(T.nilable(String)) }
|
2525
2166
|
attr_accessor :custom_mandate_url
|
2526
|
-
|
2527
2167
|
# List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.
|
2528
2168
|
sig { returns(T::Array[String]) }
|
2529
2169
|
attr_accessor :default_for
|
2530
|
-
|
2531
2170
|
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
|
2532
2171
|
sig { returns(String) }
|
2533
2172
|
attr_accessor :interval_description
|
2534
|
-
|
2535
2173
|
# Payment schedule for the mandate.
|
2536
2174
|
sig { returns(String) }
|
2537
2175
|
attr_accessor :payment_schedule
|
2538
|
-
|
2539
2176
|
# Transaction type of the mandate.
|
2540
2177
|
sig { returns(String) }
|
2541
2178
|
attr_accessor :transaction_type
|
2542
|
-
|
2543
2179
|
sig {
|
2544
2180
|
params(custom_mandate_url: T.nilable(String), default_for: T::Array[String], interval_description: String, payment_schedule: String, transaction_type: String).void
|
2545
2181
|
}
|
@@ -2554,13 +2190,11 @@ module Stripe
|
|
2554
2190
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). This is only accepted for Checkout Sessions in `setup` mode.
|
2555
2191
|
sig { returns(String) }
|
2556
2192
|
attr_accessor :currency
|
2557
|
-
|
2558
2193
|
# Additional fields for Mandate creation
|
2559
2194
|
sig {
|
2560
2195
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions)
|
2561
2196
|
}
|
2562
2197
|
attr_accessor :mandate_options
|
2563
|
-
|
2564
2198
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2565
2199
|
#
|
2566
2200
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2570,11 +2204,9 @@ module Stripe
|
|
2570
2204
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2571
2205
|
sig { returns(String) }
|
2572
2206
|
attr_accessor :setup_future_usage
|
2573
|
-
|
2574
2207
|
# Verification method for the intent
|
2575
2208
|
sig { returns(String) }
|
2576
2209
|
attr_accessor :verification_method
|
2577
|
-
|
2578
2210
|
sig {
|
2579
2211
|
params(currency: String, mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: String, verification_method: String).void
|
2580
2212
|
}
|
@@ -2595,7 +2227,6 @@ module Stripe
|
|
2595
2227
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2596
2228
|
sig { returns(String) }
|
2597
2229
|
attr_accessor :setup_future_usage
|
2598
|
-
|
2599
2230
|
sig { params(setup_future_usage: String).void }
|
2600
2231
|
def initialize(setup_future_usage: nil); end
|
2601
2232
|
end
|
@@ -2609,7 +2240,6 @@ module Stripe
|
|
2609
2240
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2610
2241
|
sig { returns(String) }
|
2611
2242
|
attr_accessor :setup_future_usage
|
2612
|
-
|
2613
2243
|
sig { params(setup_future_usage: String).void }
|
2614
2244
|
def initialize(setup_future_usage: nil); end
|
2615
2245
|
end
|
@@ -2623,7 +2253,6 @@ module Stripe
|
|
2623
2253
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2624
2254
|
sig { returns(String) }
|
2625
2255
|
attr_accessor :setup_future_usage
|
2626
|
-
|
2627
2256
|
sig { params(setup_future_usage: String).void }
|
2628
2257
|
def initialize(setup_future_usage: nil); end
|
2629
2258
|
end
|
@@ -2637,7 +2266,6 @@ module Stripe
|
|
2637
2266
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2638
2267
|
sig { returns(String) }
|
2639
2268
|
attr_accessor :setup_future_usage
|
2640
|
-
|
2641
2269
|
sig { params(setup_future_usage: String).void }
|
2642
2270
|
def initialize(setup_future_usage: nil); end
|
2643
2271
|
end
|
@@ -2651,7 +2279,6 @@ module Stripe
|
|
2651
2279
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2652
2280
|
sig { returns(String) }
|
2653
2281
|
attr_accessor :setup_future_usage
|
2654
|
-
|
2655
2282
|
sig { params(setup_future_usage: String).void }
|
2656
2283
|
def initialize(setup_future_usage: nil); end
|
2657
2284
|
end
|
@@ -2660,7 +2287,6 @@ module Stripe
|
|
2660
2287
|
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
|
2661
2288
|
sig { returns(T.nilable(String)) }
|
2662
2289
|
attr_accessor :reference_prefix
|
2663
|
-
|
2664
2290
|
sig { params(reference_prefix: T.nilable(String)).void }
|
2665
2291
|
def initialize(reference_prefix: nil); end
|
2666
2292
|
end
|
@@ -2669,7 +2295,6 @@ module Stripe
|
|
2669
2295
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)
|
2670
2296
|
}
|
2671
2297
|
attr_accessor :mandate_options
|
2672
|
-
|
2673
2298
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2674
2299
|
#
|
2675
2300
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2679,7 +2304,6 @@ module Stripe
|
|
2679
2304
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2680
2305
|
sig { returns(String) }
|
2681
2306
|
attr_accessor :setup_future_usage
|
2682
|
-
|
2683
2307
|
sig {
|
2684
2308
|
params(mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions, setup_future_usage: String).void
|
2685
2309
|
}
|
@@ -2695,7 +2319,6 @@ module Stripe
|
|
2695
2319
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2696
2320
|
sig { returns(String) }
|
2697
2321
|
attr_accessor :setup_future_usage
|
2698
|
-
|
2699
2322
|
sig { params(setup_future_usage: String).void }
|
2700
2323
|
def initialize(setup_future_usage: nil); end
|
2701
2324
|
end
|
@@ -2703,7 +2326,6 @@ module Stripe
|
|
2703
2326
|
# The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
|
2704
2327
|
sig { returns(Integer) }
|
2705
2328
|
attr_accessor :expires_after_days
|
2706
|
-
|
2707
2329
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2708
2330
|
#
|
2709
2331
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2713,7 +2335,6 @@ module Stripe
|
|
2713
2335
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2714
2336
|
sig { returns(String) }
|
2715
2337
|
attr_accessor :setup_future_usage
|
2716
|
-
|
2717
2338
|
sig { params(expires_after_days: Integer, setup_future_usage: String).void }
|
2718
2339
|
def initialize(expires_after_days: nil, setup_future_usage: nil); end
|
2719
2340
|
end
|
@@ -2723,7 +2344,6 @@ module Stripe
|
|
2723
2344
|
# Setting to false will prevent any installment plan from applying to a payment.
|
2724
2345
|
sig { returns(T::Boolean) }
|
2725
2346
|
attr_accessor :enabled
|
2726
|
-
|
2727
2347
|
sig { params(enabled: T::Boolean).void }
|
2728
2348
|
def initialize(enabled: nil); end
|
2729
2349
|
end
|
@@ -2732,31 +2352,24 @@ module Stripe
|
|
2732
2352
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Installments)
|
2733
2353
|
}
|
2734
2354
|
attr_accessor :installments
|
2735
|
-
|
2736
2355
|
# Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
|
2737
2356
|
sig { returns(String) }
|
2738
2357
|
attr_accessor :request_decremental_authorization
|
2739
|
-
|
2740
2358
|
# Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
|
2741
2359
|
sig { returns(String) }
|
2742
2360
|
attr_accessor :request_extended_authorization
|
2743
|
-
|
2744
2361
|
# Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
|
2745
2362
|
sig { returns(String) }
|
2746
2363
|
attr_accessor :request_incremental_authorization
|
2747
|
-
|
2748
2364
|
# Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
|
2749
2365
|
sig { returns(String) }
|
2750
2366
|
attr_accessor :request_multicapture
|
2751
|
-
|
2752
2367
|
# Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
|
2753
2368
|
sig { returns(String) }
|
2754
2369
|
attr_accessor :request_overcapture
|
2755
|
-
|
2756
2370
|
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
2757
2371
|
sig { returns(String) }
|
2758
2372
|
attr_accessor :request_three_d_secure
|
2759
|
-
|
2760
2373
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2761
2374
|
#
|
2762
2375
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2766,15 +2379,12 @@ module Stripe
|
|
2766
2379
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2767
2380
|
sig { returns(String) }
|
2768
2381
|
attr_accessor :setup_future_usage
|
2769
|
-
|
2770
2382
|
# Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
|
2771
2383
|
sig { returns(String) }
|
2772
2384
|
attr_accessor :statement_descriptor_suffix_kana
|
2773
|
-
|
2774
2385
|
# Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
|
2775
2386
|
sig { returns(String) }
|
2776
2387
|
attr_accessor :statement_descriptor_suffix_kanji
|
2777
|
-
|
2778
2388
|
sig {
|
2779
2389
|
params(installments: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card::Installments, request_decremental_authorization: String, request_extended_authorization: String, request_incremental_authorization: String, request_multicapture: String, request_overcapture: String, request_three_d_secure: String, setup_future_usage: String, statement_descriptor_suffix_kana: String, statement_descriptor_suffix_kanji: String).void
|
2780
2390
|
}
|
@@ -2801,7 +2411,6 @@ module Stripe
|
|
2801
2411
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2802
2412
|
sig { returns(String) }
|
2803
2413
|
attr_accessor :setup_future_usage
|
2804
|
-
|
2805
2414
|
sig { params(setup_future_usage: String).void }
|
2806
2415
|
def initialize(setup_future_usage: nil); end
|
2807
2416
|
end
|
@@ -2811,7 +2420,6 @@ module Stripe
|
|
2811
2420
|
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
|
2812
2421
|
sig { returns(String) }
|
2813
2422
|
attr_accessor :country
|
2814
|
-
|
2815
2423
|
sig { params(country: String).void }
|
2816
2424
|
def initialize(country: nil); end
|
2817
2425
|
end
|
@@ -2820,17 +2428,14 @@ module Stripe
|
|
2820
2428
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)
|
2821
2429
|
}
|
2822
2430
|
attr_accessor :eu_bank_transfer
|
2823
|
-
|
2824
2431
|
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
|
2825
2432
|
#
|
2826
2433
|
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
|
2827
2434
|
sig { returns(T::Array[String]) }
|
2828
2435
|
attr_accessor :requested_address_types
|
2829
|
-
|
2830
2436
|
# The list of bank transfer types that this PaymentIntent is allowed to use for funding.
|
2831
2437
|
sig { returns(String) }
|
2832
2438
|
attr_accessor :type
|
2833
|
-
|
2834
2439
|
sig {
|
2835
2440
|
params(eu_bank_transfer: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer, requested_address_types: T::Array[String], type: String).void
|
2836
2441
|
}
|
@@ -2841,11 +2446,9 @@ module Stripe
|
|
2841
2446
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer)
|
2842
2447
|
}
|
2843
2448
|
attr_accessor :bank_transfer
|
2844
|
-
|
2845
2449
|
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
|
2846
2450
|
sig { returns(String) }
|
2847
2451
|
attr_accessor :funding_type
|
2848
|
-
|
2849
2452
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2850
2453
|
#
|
2851
2454
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2855,7 +2458,6 @@ module Stripe
|
|
2855
2458
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2856
2459
|
sig { returns(String) }
|
2857
2460
|
attr_accessor :setup_future_usage
|
2858
|
-
|
2859
2461
|
sig {
|
2860
2462
|
params(bank_transfer: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance::BankTransfer, funding_type: String, setup_future_usage: String).void
|
2861
2463
|
}
|
@@ -2871,7 +2473,6 @@ module Stripe
|
|
2871
2473
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2872
2474
|
sig { returns(String) }
|
2873
2475
|
attr_accessor :setup_future_usage
|
2874
|
-
|
2875
2476
|
sig { params(setup_future_usage: String).void }
|
2876
2477
|
def initialize(setup_future_usage: nil); end
|
2877
2478
|
end
|
@@ -2885,7 +2486,6 @@ module Stripe
|
|
2885
2486
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2886
2487
|
sig { returns(String) }
|
2887
2488
|
attr_accessor :setup_future_usage
|
2888
|
-
|
2889
2489
|
sig { params(setup_future_usage: String).void }
|
2890
2490
|
def initialize(setup_future_usage: nil); end
|
2891
2491
|
end
|
@@ -2899,7 +2499,6 @@ module Stripe
|
|
2899
2499
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2900
2500
|
sig { returns(String) }
|
2901
2501
|
attr_accessor :setup_future_usage
|
2902
|
-
|
2903
2502
|
sig { params(setup_future_usage: String).void }
|
2904
2503
|
def initialize(setup_future_usage: nil); end
|
2905
2504
|
end
|
@@ -2913,7 +2512,6 @@ module Stripe
|
|
2913
2512
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2914
2513
|
sig { returns(String) }
|
2915
2514
|
attr_accessor :setup_future_usage
|
2916
|
-
|
2917
2515
|
sig { params(setup_future_usage: String).void }
|
2918
2516
|
def initialize(setup_future_usage: nil); end
|
2919
2517
|
end
|
@@ -2927,7 +2525,6 @@ module Stripe
|
|
2927
2525
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2928
2526
|
sig { returns(String) }
|
2929
2527
|
attr_accessor :setup_future_usage
|
2930
|
-
|
2931
2528
|
sig { params(setup_future_usage: String).void }
|
2932
2529
|
def initialize(setup_future_usage: nil); end
|
2933
2530
|
end
|
@@ -2935,7 +2532,6 @@ module Stripe
|
|
2935
2532
|
# Controls when the funds will be captured from the customer's account.
|
2936
2533
|
sig { returns(String) }
|
2937
2534
|
attr_accessor :capture_method
|
2938
|
-
|
2939
2535
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2940
2536
|
#
|
2941
2537
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2945,7 +2541,6 @@ module Stripe
|
|
2945
2541
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2946
2542
|
sig { returns(String) }
|
2947
2543
|
attr_accessor :setup_future_usage
|
2948
|
-
|
2949
2544
|
sig { params(capture_method: String, setup_future_usage: String).void }
|
2950
2545
|
def initialize(capture_method: nil, setup_future_usage: nil); end
|
2951
2546
|
end
|
@@ -2959,7 +2554,6 @@ module Stripe
|
|
2959
2554
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2960
2555
|
sig { returns(String) }
|
2961
2556
|
attr_accessor :setup_future_usage
|
2962
|
-
|
2963
2557
|
sig { params(setup_future_usage: String).void }
|
2964
2558
|
def initialize(setup_future_usage: nil); end
|
2965
2559
|
end
|
@@ -2967,7 +2561,6 @@ module Stripe
|
|
2967
2561
|
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
|
2968
2562
|
sig { returns(Integer) }
|
2969
2563
|
attr_accessor :expires_after_days
|
2970
|
-
|
2971
2564
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2972
2565
|
#
|
2973
2566
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2977,7 +2570,6 @@ module Stripe
|
|
2977
2570
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2978
2571
|
sig { returns(String) }
|
2979
2572
|
attr_accessor :setup_future_usage
|
2980
|
-
|
2981
2573
|
sig { params(expires_after_days: Integer, setup_future_usage: String).void }
|
2982
2574
|
def initialize(expires_after_days: nil, setup_future_usage: nil); end
|
2983
2575
|
end
|
@@ -2985,7 +2577,6 @@ module Stripe
|
|
2985
2577
|
# Controls when the funds will be captured from the customer's account.
|
2986
2578
|
sig { returns(String) }
|
2987
2579
|
attr_accessor :capture_method
|
2988
|
-
|
2989
2580
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2990
2581
|
#
|
2991
2582
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2995,7 +2586,6 @@ module Stripe
|
|
2995
2586
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2996
2587
|
sig { returns(String) }
|
2997
2588
|
attr_accessor :setup_future_usage
|
2998
|
-
|
2999
2589
|
sig { params(capture_method: String, setup_future_usage: String).void }
|
3000
2590
|
def initialize(capture_method: nil, setup_future_usage: nil); end
|
3001
2591
|
end
|
@@ -3009,7 +2599,6 @@ module Stripe
|
|
3009
2599
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
3010
2600
|
sig { returns(String) }
|
3011
2601
|
attr_accessor :setup_future_usage
|
3012
|
-
|
3013
2602
|
sig { params(setup_future_usage: String).void }
|
3014
2603
|
def initialize(setup_future_usage: nil); end
|
3015
2604
|
end
|
@@ -3023,7 +2612,6 @@ module Stripe
|
|
3023
2612
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
3024
2613
|
sig { returns(String) }
|
3025
2614
|
attr_accessor :setup_future_usage
|
3026
|
-
|
3027
2615
|
sig { params(setup_future_usage: String).void }
|
3028
2616
|
def initialize(setup_future_usage: nil); end
|
3029
2617
|
end
|
@@ -3037,7 +2625,6 @@ module Stripe
|
|
3037
2625
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
3038
2626
|
sig { returns(String) }
|
3039
2627
|
attr_accessor :setup_future_usage
|
3040
|
-
|
3041
2628
|
sig { params(setup_future_usage: String).void }
|
3042
2629
|
def initialize(setup_future_usage: nil); end
|
3043
2630
|
end
|
@@ -3045,7 +2632,6 @@ module Stripe
|
|
3045
2632
|
# Controls when the funds will be captured from the customer's account.
|
3046
2633
|
sig { returns(String) }
|
3047
2634
|
attr_accessor :capture_method
|
3048
|
-
|
3049
2635
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
3050
2636
|
#
|
3051
2637
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -3055,7 +2641,6 @@ module Stripe
|
|
3055
2641
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
3056
2642
|
sig { returns(String) }
|
3057
2643
|
attr_accessor :setup_future_usage
|
3058
|
-
|
3059
2644
|
sig { params(capture_method: String, setup_future_usage: String).void }
|
3060
2645
|
def initialize(capture_method: nil, setup_future_usage: nil); end
|
3061
2646
|
end
|
@@ -3063,7 +2648,6 @@ module Stripe
|
|
3063
2648
|
# The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
|
3064
2649
|
sig { returns(Integer) }
|
3065
2650
|
attr_accessor :expires_after_days
|
3066
|
-
|
3067
2651
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
3068
2652
|
#
|
3069
2653
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -3073,7 +2657,6 @@ module Stripe
|
|
3073
2657
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
3074
2658
|
sig { returns(String) }
|
3075
2659
|
attr_accessor :setup_future_usage
|
3076
|
-
|
3077
2660
|
sig { params(expires_after_days: Integer, setup_future_usage: String).void }
|
3078
2661
|
def initialize(expires_after_days: nil, setup_future_usage: nil); end
|
3079
2662
|
end
|
@@ -3087,11 +2670,9 @@ module Stripe
|
|
3087
2670
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
3088
2671
|
sig { returns(String) }
|
3089
2672
|
attr_accessor :setup_future_usage
|
3090
|
-
|
3091
2673
|
# Confirm that the payer has accepted the P24 terms and conditions.
|
3092
2674
|
sig { returns(T::Boolean) }
|
3093
2675
|
attr_accessor :tos_shown_and_accepted
|
3094
|
-
|
3095
2676
|
sig { params(setup_future_usage: String, tos_shown_and_accepted: T::Boolean).void }
|
3096
2677
|
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
|
3097
2678
|
end
|
@@ -3099,7 +2680,6 @@ module Stripe
|
|
3099
2680
|
# Controls when the funds will be captured from the customer's account.
|
3100
2681
|
sig { returns(String) }
|
3101
2682
|
attr_accessor :capture_method
|
3102
|
-
|
3103
2683
|
sig { params(capture_method: String).void }
|
3104
2684
|
def initialize(capture_method: nil); end
|
3105
2685
|
end
|
@@ -3113,7 +2693,6 @@ module Stripe
|
|
3113
2693
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
3114
2694
|
sig { returns(String) }
|
3115
2695
|
attr_accessor :setup_future_usage
|
3116
|
-
|
3117
2696
|
sig { params(setup_future_usage: String).void }
|
3118
2697
|
def initialize(setup_future_usage: nil); end
|
3119
2698
|
end
|
@@ -3121,23 +2700,18 @@ module Stripe
|
|
3121
2700
|
# Controls when the funds will be captured from the customer's account.
|
3122
2701
|
sig { returns(T.nilable(String)) }
|
3123
2702
|
attr_accessor :capture_method
|
3124
|
-
|
3125
2703
|
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
|
3126
2704
|
sig { returns(String) }
|
3127
2705
|
attr_accessor :preferred_locale
|
3128
|
-
|
3129
2706
|
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
|
3130
2707
|
sig { returns(String) }
|
3131
2708
|
attr_accessor :reference
|
3132
|
-
|
3133
2709
|
# A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
|
3134
2710
|
sig { returns(String) }
|
3135
2711
|
attr_accessor :reference_id
|
3136
|
-
|
3137
2712
|
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
|
3138
2713
|
sig { returns(String) }
|
3139
2714
|
attr_accessor :risk_correlation_id
|
3140
|
-
|
3141
2715
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
3142
2716
|
#
|
3143
2717
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -3149,11 +2723,9 @@ module Stripe
|
|
3149
2723
|
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
|
3150
2724
|
sig { returns(T.nilable(String)) }
|
3151
2725
|
attr_accessor :setup_future_usage
|
3152
|
-
|
3153
2726
|
# The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
|
3154
2727
|
sig { returns(T::Array[String]) }
|
3155
2728
|
attr_accessor :subsellers
|
3156
|
-
|
3157
2729
|
sig {
|
3158
2730
|
params(capture_method: T.nilable(String), preferred_locale: String, reference: String, reference_id: String, risk_correlation_id: String, setup_future_usage: T.nilable(String), subsellers: T::Array[String]).void
|
3159
2731
|
}
|
@@ -3172,31 +2744,24 @@ module Stripe
|
|
3172
2744
|
# Amount that will be collected. It is required when `amount_type` is `fixed`.
|
3173
2745
|
sig { returns(Integer) }
|
3174
2746
|
attr_accessor :amount
|
3175
|
-
|
3176
2747
|
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
|
3177
2748
|
sig { returns(String) }
|
3178
2749
|
attr_accessor :amount_type
|
3179
|
-
|
3180
2750
|
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
3181
2751
|
sig { returns(String) }
|
3182
2752
|
attr_accessor :end_date
|
3183
|
-
|
3184
2753
|
# The periodicity at which payments will be collected.
|
3185
2754
|
sig { returns(String) }
|
3186
2755
|
attr_accessor :payment_schedule
|
3187
|
-
|
3188
2756
|
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
|
3189
2757
|
sig { returns(Integer) }
|
3190
2758
|
attr_accessor :payments_per_period
|
3191
|
-
|
3192
2759
|
# The purpose for which payments are made. Defaults to retail.
|
3193
2760
|
sig { returns(String) }
|
3194
2761
|
attr_accessor :purpose
|
3195
|
-
|
3196
2762
|
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
3197
2763
|
sig { returns(String) }
|
3198
2764
|
attr_accessor :start_date
|
3199
|
-
|
3200
2765
|
sig {
|
3201
2766
|
params(amount: Integer, amount_type: String, end_date: String, payment_schedule: String, payments_per_period: Integer, purpose: String, start_date: String).void
|
3202
2767
|
}
|
@@ -3215,7 +2780,6 @@ module Stripe
|
|
3215
2780
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto::MandateOptions)
|
3216
2781
|
}
|
3217
2782
|
attr_accessor :mandate_options
|
3218
|
-
|
3219
2783
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
3220
2784
|
#
|
3221
2785
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -3225,7 +2789,6 @@ module Stripe
|
|
3225
2789
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
3226
2790
|
sig { returns(String) }
|
3227
2791
|
attr_accessor :setup_future_usage
|
3228
|
-
|
3229
2792
|
sig {
|
3230
2793
|
params(mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto::MandateOptions, setup_future_usage: String).void
|
3231
2794
|
}
|
@@ -3235,7 +2798,6 @@ module Stripe
|
|
3235
2798
|
# The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
|
3236
2799
|
sig { returns(Integer) }
|
3237
2800
|
attr_accessor :expires_after_seconds
|
3238
|
-
|
3239
2801
|
sig { params(expires_after_seconds: Integer).void }
|
3240
2802
|
def initialize(expires_after_seconds: nil); end
|
3241
2803
|
end
|
@@ -3249,7 +2811,6 @@ module Stripe
|
|
3249
2811
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
3250
2812
|
sig { returns(String) }
|
3251
2813
|
attr_accessor :setup_future_usage
|
3252
|
-
|
3253
2814
|
sig { params(setup_future_usage: String).void }
|
3254
2815
|
def initialize(setup_future_usage: nil); end
|
3255
2816
|
end
|
@@ -3257,7 +2818,6 @@ module Stripe
|
|
3257
2818
|
# Controls when the funds will be captured from the customer's account.
|
3258
2819
|
sig { returns(String) }
|
3259
2820
|
attr_accessor :capture_method
|
3260
|
-
|
3261
2821
|
sig { params(capture_method: String).void }
|
3262
2822
|
def initialize(capture_method: nil); end
|
3263
2823
|
end
|
@@ -3266,7 +2826,6 @@ module Stripe
|
|
3266
2826
|
# Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
|
3267
2827
|
sig { returns(T.nilable(String)) }
|
3268
2828
|
attr_accessor :reference_prefix
|
3269
|
-
|
3270
2829
|
sig { params(reference_prefix: T.nilable(String)).void }
|
3271
2830
|
def initialize(reference_prefix: nil); end
|
3272
2831
|
end
|
@@ -3275,7 +2834,6 @@ module Stripe
|
|
3275
2834
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)
|
3276
2835
|
}
|
3277
2836
|
attr_accessor :mandate_options
|
3278
|
-
|
3279
2837
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
3280
2838
|
#
|
3281
2839
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -3285,7 +2843,6 @@ module Stripe
|
|
3285
2843
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
3286
2844
|
sig { returns(String) }
|
3287
2845
|
attr_accessor :setup_future_usage
|
3288
|
-
|
3289
2846
|
sig {
|
3290
2847
|
params(mandate_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: String).void
|
3291
2848
|
}
|
@@ -3301,7 +2858,6 @@ module Stripe
|
|
3301
2858
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
3302
2859
|
sig { returns(String) }
|
3303
2860
|
attr_accessor :setup_future_usage
|
3304
|
-
|
3305
2861
|
sig { params(setup_future_usage: String).void }
|
3306
2862
|
def initialize(setup_future_usage: nil); end
|
3307
2863
|
end
|
@@ -3309,7 +2865,6 @@ module Stripe
|
|
3309
2865
|
# The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
|
3310
2866
|
sig { returns(String) }
|
3311
2867
|
attr_accessor :reference
|
3312
|
-
|
3313
2868
|
sig { params(reference: String).void }
|
3314
2869
|
def initialize(reference: nil); end
|
3315
2870
|
end
|
@@ -3318,11 +2873,9 @@ module Stripe
|
|
3318
2873
|
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
|
3319
2874
|
sig { returns(T::Array[String]) }
|
3320
2875
|
attr_accessor :permissions
|
3321
|
-
|
3322
2876
|
# List of data features that you would like to retrieve upon account creation.
|
3323
2877
|
sig { returns(T::Array[String]) }
|
3324
2878
|
attr_accessor :prefetch
|
3325
|
-
|
3326
2879
|
sig { params(permissions: T::Array[String], prefetch: T::Array[String]).void }
|
3327
2880
|
def initialize(permissions: nil, prefetch: nil); end
|
3328
2881
|
end
|
@@ -3331,7 +2884,6 @@ module Stripe
|
|
3331
2884
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections)
|
3332
2885
|
}
|
3333
2886
|
attr_accessor :financial_connections
|
3334
|
-
|
3335
2887
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
3336
2888
|
#
|
3337
2889
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -3341,11 +2893,9 @@ module Stripe
|
|
3341
2893
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
3342
2894
|
sig { returns(String) }
|
3343
2895
|
attr_accessor :setup_future_usage
|
3344
|
-
|
3345
2896
|
# Verification method for the intent
|
3346
2897
|
sig { returns(String) }
|
3347
2898
|
attr_accessor :verification_method
|
3348
|
-
|
3349
2899
|
sig {
|
3350
2900
|
params(financial_connections: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, setup_future_usage: String, verification_method: String).void
|
3351
2901
|
}
|
@@ -3359,11 +2909,9 @@ module Stripe
|
|
3359
2909
|
# The app ID registered with WeChat Pay. Only required when client is ios or android.
|
3360
2910
|
sig { returns(String) }
|
3361
2911
|
attr_accessor :app_id
|
3362
|
-
|
3363
2912
|
# The client type that the end customer will pay from
|
3364
2913
|
sig { returns(String) }
|
3365
2914
|
attr_accessor :client
|
3366
|
-
|
3367
2915
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
3368
2916
|
#
|
3369
2917
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -3373,7 +2921,6 @@ module Stripe
|
|
3373
2921
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
3374
2922
|
sig { returns(String) }
|
3375
2923
|
attr_accessor :setup_future_usage
|
3376
|
-
|
3377
2924
|
sig { params(app_id: String, client: String, setup_future_usage: String).void }
|
3378
2925
|
def initialize(app_id: nil, client: nil, setup_future_usage: nil); end
|
3379
2926
|
end
|
@@ -3382,185 +2929,146 @@ module Stripe
|
|
3382
2929
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit)
|
3383
2930
|
}
|
3384
2931
|
attr_accessor :acss_debit
|
3385
|
-
|
3386
2932
|
# contains details about the Affirm payment method options.
|
3387
2933
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Affirm) }
|
3388
2934
|
attr_accessor :affirm
|
3389
|
-
|
3390
2935
|
# contains details about the Afterpay Clearpay payment method options.
|
3391
2936
|
sig {
|
3392
2937
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AfterpayClearpay)
|
3393
2938
|
}
|
3394
2939
|
attr_accessor :afterpay_clearpay
|
3395
|
-
|
3396
2940
|
# contains details about the Alipay payment method options.
|
3397
2941
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Alipay) }
|
3398
2942
|
attr_accessor :alipay
|
3399
|
-
|
3400
2943
|
# contains details about the AmazonPay payment method options.
|
3401
2944
|
sig {
|
3402
2945
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AmazonPay)
|
3403
2946
|
}
|
3404
2947
|
attr_accessor :amazon_pay
|
3405
|
-
|
3406
2948
|
# contains details about the AU Becs Debit payment method options.
|
3407
2949
|
sig {
|
3408
2950
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AuBecsDebit)
|
3409
2951
|
}
|
3410
2952
|
attr_accessor :au_becs_debit
|
3411
|
-
|
3412
2953
|
# contains details about the Bacs Debit payment method options.
|
3413
2954
|
sig {
|
3414
2955
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit)
|
3415
2956
|
}
|
3416
2957
|
attr_accessor :bacs_debit
|
3417
|
-
|
3418
2958
|
# contains details about the Bancontact payment method options.
|
3419
2959
|
sig {
|
3420
2960
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Bancontact)
|
3421
2961
|
}
|
3422
2962
|
attr_accessor :bancontact
|
3423
|
-
|
3424
2963
|
# contains details about the Boleto payment method options.
|
3425
2964
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Boleto) }
|
3426
2965
|
attr_accessor :boleto
|
3427
|
-
|
3428
2966
|
# contains details about the Card payment method options.
|
3429
2967
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card) }
|
3430
2968
|
attr_accessor :card
|
3431
|
-
|
3432
2969
|
# contains details about the Cashapp Pay payment method options.
|
3433
2970
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Cashapp) }
|
3434
2971
|
attr_accessor :cashapp
|
3435
|
-
|
3436
2972
|
# contains details about the Customer Balance payment method options.
|
3437
2973
|
sig {
|
3438
2974
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance)
|
3439
2975
|
}
|
3440
2976
|
attr_accessor :customer_balance
|
3441
|
-
|
3442
2977
|
# contains details about the EPS payment method options.
|
3443
2978
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Eps) }
|
3444
2979
|
attr_accessor :eps
|
3445
|
-
|
3446
2980
|
# contains details about the FPX payment method options.
|
3447
2981
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Fpx) }
|
3448
2982
|
attr_accessor :fpx
|
3449
|
-
|
3450
2983
|
# contains details about the Giropay payment method options.
|
3451
2984
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Giropay) }
|
3452
2985
|
attr_accessor :giropay
|
3453
|
-
|
3454
2986
|
# contains details about the Grabpay payment method options.
|
3455
2987
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Grabpay) }
|
3456
2988
|
attr_accessor :grabpay
|
3457
|
-
|
3458
2989
|
# contains details about the Ideal payment method options.
|
3459
2990
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Ideal) }
|
3460
2991
|
attr_accessor :ideal
|
3461
|
-
|
3462
2992
|
# contains details about the Kakao Pay payment method options.
|
3463
2993
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KakaoPay) }
|
3464
2994
|
attr_accessor :kakao_pay
|
3465
|
-
|
3466
2995
|
# contains details about the Klarna payment method options.
|
3467
2996
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna) }
|
3468
2997
|
attr_accessor :klarna
|
3469
|
-
|
3470
2998
|
# contains details about the Konbini payment method options.
|
3471
2999
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Konbini) }
|
3472
3000
|
attr_accessor :konbini
|
3473
|
-
|
3474
3001
|
# contains details about the Korean card payment method options.
|
3475
3002
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KrCard) }
|
3476
3003
|
attr_accessor :kr_card
|
3477
|
-
|
3478
3004
|
# contains details about the Link payment method options.
|
3479
3005
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Link) }
|
3480
3006
|
attr_accessor :link
|
3481
|
-
|
3482
3007
|
# contains details about the Mobilepay payment method options.
|
3483
3008
|
sig {
|
3484
3009
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Mobilepay)
|
3485
3010
|
}
|
3486
3011
|
attr_accessor :mobilepay
|
3487
|
-
|
3488
3012
|
# contains details about the Multibanco payment method options.
|
3489
3013
|
sig {
|
3490
3014
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Multibanco)
|
3491
3015
|
}
|
3492
3016
|
attr_accessor :multibanco
|
3493
|
-
|
3494
3017
|
# contains details about the Naver Pay payment method options.
|
3495
3018
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::NaverPay) }
|
3496
3019
|
attr_accessor :naver_pay
|
3497
|
-
|
3498
3020
|
# contains details about the OXXO payment method options.
|
3499
3021
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Oxxo) }
|
3500
3022
|
attr_accessor :oxxo
|
3501
|
-
|
3502
3023
|
# contains details about the P24 payment method options.
|
3503
3024
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::P24) }
|
3504
3025
|
attr_accessor :p24
|
3505
|
-
|
3506
3026
|
# contains details about the PAYCO payment method options.
|
3507
3027
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payco) }
|
3508
3028
|
attr_accessor :payco
|
3509
|
-
|
3510
3029
|
# contains details about the PayNow payment method options.
|
3511
3030
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paynow) }
|
3512
3031
|
attr_accessor :paynow
|
3513
|
-
|
3514
3032
|
# contains details about the PayPal payment method options.
|
3515
3033
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paypal) }
|
3516
3034
|
attr_accessor :paypal
|
3517
|
-
|
3518
3035
|
# contains details about the PayTo payment method options.
|
3519
3036
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto) }
|
3520
3037
|
attr_accessor :payto
|
3521
|
-
|
3522
3038
|
# contains details about the Pix payment method options.
|
3523
3039
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix) }
|
3524
3040
|
attr_accessor :pix
|
3525
|
-
|
3526
3041
|
# contains details about the RevolutPay payment method options.
|
3527
3042
|
sig {
|
3528
3043
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::RevolutPay)
|
3529
3044
|
}
|
3530
3045
|
attr_accessor :revolut_pay
|
3531
|
-
|
3532
3046
|
# contains details about the Samsung Pay payment method options.
|
3533
3047
|
sig {
|
3534
3048
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SamsungPay)
|
3535
3049
|
}
|
3536
3050
|
attr_accessor :samsung_pay
|
3537
|
-
|
3538
3051
|
# contains details about the Sepa Debit payment method options.
|
3539
3052
|
sig {
|
3540
3053
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit)
|
3541
3054
|
}
|
3542
3055
|
attr_accessor :sepa_debit
|
3543
|
-
|
3544
3056
|
# contains details about the Sofort payment method options.
|
3545
3057
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Sofort) }
|
3546
3058
|
attr_accessor :sofort
|
3547
|
-
|
3548
3059
|
# contains details about the Swish payment method options.
|
3549
3060
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Swish) }
|
3550
3061
|
attr_accessor :swish
|
3551
|
-
|
3552
3062
|
# contains details about the Us Bank Account payment method options.
|
3553
3063
|
sig {
|
3554
3064
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount)
|
3555
3065
|
}
|
3556
3066
|
attr_accessor :us_bank_account
|
3557
|
-
|
3558
3067
|
# contains details about the WeChat Pay payment method options.
|
3559
3068
|
sig {
|
3560
3069
|
returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::WechatPay)
|
3561
3070
|
}
|
3562
3071
|
attr_accessor :wechat_pay
|
3563
|
-
|
3564
3072
|
sig {
|
3565
3073
|
params(acss_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AcssDebit, affirm: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Affirm, afterpay_clearpay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AfterpayClearpay, alipay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Alipay, amazon_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AmazonPay, au_becs_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::AuBecsDebit, bacs_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::BacsDebit, bancontact: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Bancontact, boleto: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Boleto, card: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card, cashapp: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Cashapp, customer_balance: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::CustomerBalance, eps: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Eps, fpx: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Fpx, giropay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Giropay, grabpay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Grabpay, ideal: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Ideal, kakao_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KakaoPay, klarna: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Klarna, konbini: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Konbini, kr_card: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::KrCard, link: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Link, mobilepay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Mobilepay, multibanco: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Multibanco, naver_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::NaverPay, oxxo: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Oxxo, p24: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::P24, payco: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payco, paynow: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paynow, paypal: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Paypal, payto: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto, pix: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Pix, revolut_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::RevolutPay, samsung_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SamsungPay, sepa_debit: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::SepaDebit, sofort: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Sofort, swish: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Swish, us_bank_account: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::UsBankAccount, wechat_pay: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::WechatPay).void
|
3566
3074
|
}
|
@@ -3615,7 +3123,6 @@ module Stripe
|
|
3615
3123
|
# When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
|
3616
3124
|
sig { returns(String) }
|
3617
3125
|
attr_accessor :line_items
|
3618
|
-
|
3619
3126
|
# Determines which entity is allowed to update the shipping details.
|
3620
3127
|
#
|
3621
3128
|
# Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
|
@@ -3623,14 +3130,12 @@ module Stripe
|
|
3623
3130
|
# When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
|
3624
3131
|
sig { returns(String) }
|
3625
3132
|
attr_accessor :shipping_details
|
3626
|
-
|
3627
3133
|
sig { params(line_items: String, shipping_details: String).void }
|
3628
3134
|
def initialize(line_items: nil, shipping_details: nil); end
|
3629
3135
|
end
|
3630
3136
|
# Permissions for updating the Checkout Session.
|
3631
3137
|
sig { returns(::Stripe::Checkout::Session::CreateParams::Permissions::Update) }
|
3632
3138
|
attr_accessor :update
|
3633
|
-
|
3634
3139
|
sig {
|
3635
3140
|
params(update: ::Stripe::Checkout::Session::CreateParams::Permissions::Update).void
|
3636
3141
|
}
|
@@ -3638,9 +3143,10 @@ module Stripe
|
|
3638
3143
|
end
|
3639
3144
|
class PhoneNumberCollection < Stripe::RequestParams
|
3640
3145
|
# Set to `true` to enable phone number collection.
|
3146
|
+
#
|
3147
|
+
# Can only be set in `payment` and `subscription` mode.
|
3641
3148
|
sig { returns(T::Boolean) }
|
3642
3149
|
attr_accessor :enabled
|
3643
|
-
|
3644
3150
|
sig { params(enabled: T::Boolean).void }
|
3645
3151
|
def initialize(enabled: nil); end
|
3646
3152
|
end
|
@@ -3648,11 +3154,9 @@ module Stripe
|
|
3648
3154
|
# Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.
|
3649
3155
|
sig { returns(T::Array[String]) }
|
3650
3156
|
attr_accessor :allow_redisplay_filters
|
3651
|
-
|
3652
3157
|
# Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
|
3653
3158
|
sig { returns(String) }
|
3654
3159
|
attr_accessor :payment_method_save
|
3655
|
-
|
3656
3160
|
sig {
|
3657
3161
|
params(allow_redisplay_filters: T::Array[String], payment_method_save: String).void
|
3658
3162
|
}
|
@@ -3662,15 +3166,12 @@ module Stripe
|
|
3662
3166
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
3663
3167
|
sig { returns(String) }
|
3664
3168
|
attr_accessor :description
|
3665
|
-
|
3666
3169
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
3667
3170
|
sig { returns(T::Hash[String, String]) }
|
3668
3171
|
attr_accessor :metadata
|
3669
|
-
|
3670
3172
|
# The Stripe account for which the setup is intended.
|
3671
3173
|
sig { returns(String) }
|
3672
3174
|
attr_accessor :on_behalf_of
|
3673
|
-
|
3674
3175
|
sig {
|
3675
3176
|
params(description: String, metadata: T::Hash[String, String], on_behalf_of: String).void
|
3676
3177
|
}
|
@@ -3681,7 +3182,6 @@ module Stripe
|
|
3681
3182
|
# shipping locations.
|
3682
3183
|
sig { returns(T::Array[String]) }
|
3683
3184
|
attr_accessor :allowed_countries
|
3684
|
-
|
3685
3185
|
sig { params(allowed_countries: T::Array[String]).void }
|
3686
3186
|
def initialize(allowed_countries: nil); end
|
3687
3187
|
end
|
@@ -3692,11 +3192,9 @@ module Stripe
|
|
3692
3192
|
# A unit of time.
|
3693
3193
|
sig { returns(String) }
|
3694
3194
|
attr_accessor :unit
|
3695
|
-
|
3696
3195
|
# Must be greater than 0.
|
3697
3196
|
sig { returns(Integer) }
|
3698
3197
|
attr_accessor :value
|
3699
|
-
|
3700
3198
|
sig { params(unit: String, value: Integer).void }
|
3701
3199
|
def initialize(unit: nil, value: nil); end
|
3702
3200
|
end
|
@@ -3704,11 +3202,9 @@ module Stripe
|
|
3704
3202
|
# A unit of time.
|
3705
3203
|
sig { returns(String) }
|
3706
3204
|
attr_accessor :unit
|
3707
|
-
|
3708
3205
|
# Must be greater than 0.
|
3709
3206
|
sig { returns(Integer) }
|
3710
3207
|
attr_accessor :value
|
3711
|
-
|
3712
3208
|
sig { params(unit: String, value: Integer).void }
|
3713
3209
|
def initialize(unit: nil, value: nil); end
|
3714
3210
|
end
|
@@ -3717,13 +3213,11 @@ module Stripe
|
|
3717
3213
|
returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)
|
3718
3214
|
}
|
3719
3215
|
attr_accessor :maximum
|
3720
|
-
|
3721
3216
|
# The lower bound of the estimated range. If empty, represents no lower bound.
|
3722
3217
|
sig {
|
3723
3218
|
returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)
|
3724
3219
|
}
|
3725
3220
|
attr_accessor :minimum
|
3726
|
-
|
3727
3221
|
sig {
|
3728
3222
|
params(maximum: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum, minimum: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum).void
|
3729
3223
|
}
|
@@ -3734,28 +3228,23 @@ module Stripe
|
|
3734
3228
|
# A non-negative integer in cents representing how much to charge.
|
3735
3229
|
sig { returns(Integer) }
|
3736
3230
|
attr_accessor :amount
|
3737
|
-
|
3738
3231
|
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
3739
3232
|
sig { returns(String) }
|
3740
3233
|
attr_accessor :tax_behavior
|
3741
|
-
|
3742
3234
|
sig { params(amount: Integer, tax_behavior: String).void }
|
3743
3235
|
def initialize(amount: nil, tax_behavior: nil); end
|
3744
3236
|
end
|
3745
3237
|
# A non-negative integer in cents representing how much to charge.
|
3746
3238
|
sig { returns(Integer) }
|
3747
3239
|
attr_accessor :amount
|
3748
|
-
|
3749
3240
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
3750
3241
|
sig { returns(String) }
|
3751
3242
|
attr_accessor :currency
|
3752
|
-
|
3753
3243
|
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
|
3754
3244
|
sig {
|
3755
3245
|
returns(T::Hash[String, ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])
|
3756
3246
|
}
|
3757
3247
|
attr_accessor :currency_options
|
3758
|
-
|
3759
3248
|
sig {
|
3760
3249
|
params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]).void
|
3761
3250
|
}
|
@@ -3766,33 +3255,26 @@ module Stripe
|
|
3766
3255
|
returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate)
|
3767
3256
|
}
|
3768
3257
|
attr_accessor :delivery_estimate
|
3769
|
-
|
3770
3258
|
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
|
3771
3259
|
sig { returns(String) }
|
3772
3260
|
attr_accessor :display_name
|
3773
|
-
|
3774
3261
|
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
|
3775
3262
|
sig {
|
3776
3263
|
returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount)
|
3777
3264
|
}
|
3778
3265
|
attr_accessor :fixed_amount
|
3779
|
-
|
3780
3266
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
3781
3267
|
sig { returns(T::Hash[String, String]) }
|
3782
3268
|
attr_accessor :metadata
|
3783
|
-
|
3784
3269
|
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
3785
3270
|
sig { returns(String) }
|
3786
3271
|
attr_accessor :tax_behavior
|
3787
|
-
|
3788
3272
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
|
3789
3273
|
sig { returns(String) }
|
3790
3274
|
attr_accessor :tax_code
|
3791
|
-
|
3792
3275
|
# The type of calculation to use on the shipping rate.
|
3793
3276
|
sig { returns(String) }
|
3794
3277
|
attr_accessor :type
|
3795
|
-
|
3796
3278
|
sig {
|
3797
3279
|
params(delivery_estimate: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::DeliveryEstimate, display_name: String, fixed_amount: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData::FixedAmount, metadata: T::Hash[String, String], tax_behavior: String, tax_code: String, type: String).void
|
3798
3280
|
}
|
@@ -3809,13 +3291,11 @@ module Stripe
|
|
3809
3291
|
# The ID of the Shipping Rate to use for this shipping option.
|
3810
3292
|
sig { returns(String) }
|
3811
3293
|
attr_accessor :shipping_rate
|
3812
|
-
|
3813
3294
|
# Parameters to be passed to Shipping Rate creation for this shipping option.
|
3814
3295
|
sig {
|
3815
3296
|
returns(::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData)
|
3816
3297
|
}
|
3817
3298
|
attr_accessor :shipping_rate_data
|
3818
|
-
|
3819
3299
|
sig {
|
3820
3300
|
params(shipping_rate: String, shipping_rate_data: ::Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData).void
|
3821
3301
|
}
|
@@ -3827,11 +3307,9 @@ module Stripe
|
|
3827
3307
|
# The connected account being referenced when `type` is `account`.
|
3828
3308
|
sig { returns(String) }
|
3829
3309
|
attr_accessor :account
|
3830
|
-
|
3831
3310
|
# Type of the account referenced in the request.
|
3832
3311
|
sig { returns(String) }
|
3833
3312
|
attr_accessor :type
|
3834
|
-
|
3835
3313
|
sig { params(account: String, type: String).void }
|
3836
3314
|
def initialize(account: nil, type: nil); end
|
3837
3315
|
end
|
@@ -3840,7 +3318,6 @@ module Stripe
|
|
3840
3318
|
returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings::Issuer)
|
3841
3319
|
}
|
3842
3320
|
attr_accessor :issuer
|
3843
|
-
|
3844
3321
|
sig {
|
3845
3322
|
params(issuer: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings::Issuer).void
|
3846
3323
|
}
|
@@ -3850,11 +3327,9 @@ module Stripe
|
|
3850
3327
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
|
3851
3328
|
sig { returns(Float) }
|
3852
3329
|
attr_accessor :amount_percent
|
3853
|
-
|
3854
3330
|
# ID of an existing, connected Stripe account.
|
3855
3331
|
sig { returns(String) }
|
3856
3332
|
attr_accessor :destination
|
3857
|
-
|
3858
3333
|
sig { params(amount_percent: Float, destination: String).void }
|
3859
3334
|
def initialize(amount_percent: nil, destination: nil); end
|
3860
3335
|
end
|
@@ -3863,7 +3338,6 @@ module Stripe
|
|
3863
3338
|
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
|
3864
3339
|
sig { returns(String) }
|
3865
3340
|
attr_accessor :missing_payment_method
|
3866
|
-
|
3867
3341
|
sig { params(missing_payment_method: String).void }
|
3868
3342
|
def initialize(missing_payment_method: nil); end
|
3869
3343
|
end
|
@@ -3872,7 +3346,6 @@ module Stripe
|
|
3872
3346
|
returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings::EndBehavior)
|
3873
3347
|
}
|
3874
3348
|
attr_accessor :end_behavior
|
3875
|
-
|
3876
3349
|
sig {
|
3877
3350
|
params(end_behavior: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings::EndBehavior).void
|
3878
3351
|
}
|
@@ -3881,62 +3354,50 @@ module Stripe
|
|
3881
3354
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
|
3882
3355
|
sig { returns(Float) }
|
3883
3356
|
attr_accessor :application_fee_percent
|
3884
|
-
|
3885
3357
|
# A future timestamp to anchor the subscription's billing cycle for new subscriptions.
|
3886
3358
|
sig { returns(Integer) }
|
3887
3359
|
attr_accessor :billing_cycle_anchor
|
3888
|
-
|
3889
3360
|
# The tax rates that will apply to any subscription item that does not have
|
3890
3361
|
# `tax_rates` set. Invoices created will have their `default_tax_rates` populated
|
3891
3362
|
# from the subscription.
|
3892
3363
|
sig { returns(T::Array[String]) }
|
3893
3364
|
attr_accessor :default_tax_rates
|
3894
|
-
|
3895
3365
|
# The subscription's description, meant to be displayable to the customer.
|
3896
3366
|
# Use this field to optionally store an explanation of the subscription
|
3897
3367
|
# for rendering in the [customer portal](https://stripe.com/docs/customer-management).
|
3898
3368
|
sig { returns(String) }
|
3899
3369
|
attr_accessor :description
|
3900
|
-
|
3901
3370
|
# All invoices will be billed using the specified settings.
|
3902
3371
|
sig {
|
3903
3372
|
returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings)
|
3904
3373
|
}
|
3905
3374
|
attr_accessor :invoice_settings
|
3906
|
-
|
3907
3375
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
3908
3376
|
sig { returns(T::Hash[String, String]) }
|
3909
3377
|
attr_accessor :metadata
|
3910
|
-
|
3911
3378
|
# The account on behalf of which to charge, for each of the subscription's invoices.
|
3912
3379
|
sig { returns(String) }
|
3913
3380
|
attr_accessor :on_behalf_of
|
3914
|
-
|
3915
3381
|
# Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
|
3916
3382
|
sig { returns(String) }
|
3917
3383
|
attr_accessor :proration_behavior
|
3918
|
-
|
3919
3384
|
# If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
|
3920
3385
|
sig { returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TransferData) }
|
3921
3386
|
attr_accessor :transfer_data
|
3922
|
-
|
3923
3387
|
# Unix timestamp representing the end of the trial period the customer
|
3924
3388
|
# will get before being charged for the first time. Has to be at least
|
3925
3389
|
# 48 hours in the future.
|
3926
3390
|
sig { returns(Integer) }
|
3927
3391
|
attr_accessor :trial_end
|
3928
|
-
|
3929
3392
|
# Integer representing the number of trial period days before the
|
3930
3393
|
# customer is charged for the first time. Has to be at least 1.
|
3931
3394
|
sig { returns(Integer) }
|
3932
3395
|
attr_accessor :trial_period_days
|
3933
|
-
|
3934
3396
|
# Settings related to subscription trials.
|
3935
3397
|
sig {
|
3936
3398
|
returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings)
|
3937
3399
|
}
|
3938
3400
|
attr_accessor :trial_settings
|
3939
|
-
|
3940
3401
|
sig {
|
3941
3402
|
params(application_fee_percent: Float, billing_cycle_anchor: Integer, default_tax_rates: T::Array[String], description: String, invoice_settings: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::InvoiceSettings, metadata: T::Hash[String, String], on_behalf_of: String, proration_behavior: String, transfer_data: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::TransferData, trial_end: Integer, trial_period_days: Integer, trial_settings: ::Stripe::Checkout::Session::CreateParams::SubscriptionData::TrialSettings).void
|
3942
3403
|
}
|
@@ -3959,60 +3420,47 @@ module Stripe
|
|
3959
3420
|
# Enable tax ID collection during checkout. Defaults to `false`.
|
3960
3421
|
sig { returns(T::Boolean) }
|
3961
3422
|
attr_accessor :enabled
|
3962
|
-
|
3963
3423
|
# Describes whether a tax ID is required during checkout. Defaults to `never`.
|
3964
3424
|
sig { returns(String) }
|
3965
3425
|
attr_accessor :required
|
3966
|
-
|
3967
3426
|
sig { params(enabled: T::Boolean, required: String).void }
|
3968
3427
|
def initialize(enabled: nil, required: nil); end
|
3969
3428
|
end
|
3970
3429
|
# Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
|
3971
3430
|
sig { returns(::Stripe::Checkout::Session::CreateParams::AdaptivePricing) }
|
3972
3431
|
attr_accessor :adaptive_pricing
|
3973
|
-
|
3974
3432
|
# Configure actions after a Checkout Session has expired.
|
3975
3433
|
sig { returns(::Stripe::Checkout::Session::CreateParams::AfterExpiration) }
|
3976
3434
|
attr_accessor :after_expiration
|
3977
|
-
|
3978
3435
|
# Enables user redeemable promotion codes.
|
3979
3436
|
sig { returns(T::Boolean) }
|
3980
3437
|
attr_accessor :allow_promotion_codes
|
3981
|
-
|
3982
3438
|
# Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
|
3983
3439
|
sig { returns(::Stripe::Checkout::Session::CreateParams::AutomaticTax) }
|
3984
3440
|
attr_accessor :automatic_tax
|
3985
|
-
|
3986
3441
|
# Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
|
3987
3442
|
sig { returns(String) }
|
3988
3443
|
attr_accessor :billing_address_collection
|
3989
|
-
|
3990
3444
|
# If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded` or `custom`.
|
3991
3445
|
sig { returns(String) }
|
3992
3446
|
attr_accessor :cancel_url
|
3993
|
-
|
3994
3447
|
# A unique string to reference the Checkout Session. This can be a
|
3995
3448
|
# customer ID, a cart ID, or similar, and can be used to reconcile the
|
3996
3449
|
# session with your internal systems.
|
3997
3450
|
sig { returns(String) }
|
3998
3451
|
attr_accessor :client_reference_id
|
3999
|
-
|
4000
3452
|
# Configure fields for the Checkout Session to gather active consent from customers.
|
4001
3453
|
sig { returns(::Stripe::Checkout::Session::CreateParams::ConsentCollection) }
|
4002
3454
|
attr_accessor :consent_collection
|
4003
|
-
|
4004
3455
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set.
|
4005
3456
|
sig { returns(String) }
|
4006
3457
|
attr_accessor :currency
|
4007
|
-
|
4008
3458
|
# Collect additional information from your customer using custom fields. Up to 3 fields are supported.
|
4009
3459
|
sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::CustomField]) }
|
4010
3460
|
attr_accessor :custom_fields
|
4011
|
-
|
4012
3461
|
# Display additional text for your customers using custom text.
|
4013
3462
|
sig { returns(::Stripe::Checkout::Session::CreateParams::CustomText) }
|
4014
3463
|
attr_accessor :custom_text
|
4015
|
-
|
4016
3464
|
# ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
|
4017
3465
|
# payment method will be used to prefill the email, name, card details, and billing address
|
4018
3466
|
# on the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)
|
@@ -4026,7 +3474,6 @@ module Stripe
|
|
4026
3474
|
# You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.
|
4027
3475
|
sig { returns(String) }
|
4028
3476
|
attr_accessor :customer
|
4029
|
-
|
4030
3477
|
# Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
|
4031
3478
|
#
|
4032
3479
|
# When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
|
@@ -4038,7 +3485,6 @@ module Stripe
|
|
4038
3485
|
# Can only be set in `payment` and `setup` mode.
|
4039
3486
|
sig { returns(String) }
|
4040
3487
|
attr_accessor :customer_creation
|
4041
|
-
|
4042
3488
|
# If provided, this value will be used when the Customer object is created.
|
4043
3489
|
# If not provided, customers will be asked to enter their email address.
|
4044
3490
|
# Use this parameter to prefill customer data if you already have an email
|
@@ -4046,27 +3492,21 @@ module Stripe
|
|
4046
3492
|
# complete, use the `customer` field.
|
4047
3493
|
sig { returns(String) }
|
4048
3494
|
attr_accessor :customer_email
|
4049
|
-
|
4050
3495
|
# Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
|
4051
3496
|
sig { returns(::Stripe::Checkout::Session::CreateParams::CustomerUpdate) }
|
4052
3497
|
attr_accessor :customer_update
|
4053
|
-
|
4054
3498
|
# The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
|
4055
3499
|
sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::Discount]) }
|
4056
3500
|
attr_accessor :discounts
|
4057
|
-
|
4058
3501
|
# Specifies which fields in the response should be expanded.
|
4059
3502
|
sig { returns(T::Array[String]) }
|
4060
3503
|
attr_accessor :expand
|
4061
|
-
|
4062
3504
|
# The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
|
4063
3505
|
sig { returns(Integer) }
|
4064
3506
|
attr_accessor :expires_at
|
4065
|
-
|
4066
3507
|
# Generate a post-purchase Invoice for one-time payments.
|
4067
3508
|
sig { returns(::Stripe::Checkout::Session::CreateParams::InvoiceCreation) }
|
4068
3509
|
attr_accessor :invoice_creation
|
4069
|
-
|
4070
3510
|
# A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
|
4071
3511
|
#
|
4072
3512
|
# 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.
|
@@ -4074,23 +3514,18 @@ module Stripe
|
|
4074
3514
|
# For `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.
|
4075
3515
|
sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::LineItem]) }
|
4076
3516
|
attr_accessor :line_items
|
4077
|
-
|
4078
3517
|
# The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
|
4079
3518
|
sig { returns(String) }
|
4080
3519
|
attr_accessor :locale
|
4081
|
-
|
4082
3520
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
4083
3521
|
sig { returns(T::Hash[String, String]) }
|
4084
3522
|
attr_accessor :metadata
|
4085
|
-
|
4086
3523
|
# The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
|
4087
3524
|
sig { returns(String) }
|
4088
3525
|
attr_accessor :mode
|
4089
|
-
|
4090
3526
|
# A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
|
4091
3527
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentIntentData) }
|
4092
3528
|
attr_accessor :payment_intent_data
|
4093
|
-
|
4094
3529
|
# Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.
|
4095
3530
|
# This may occur if the Checkout Session includes a free trial or a discount.
|
4096
3531
|
#
|
@@ -4099,19 +3534,15 @@ module Stripe
|
|
4099
3534
|
# If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
|
4100
3535
|
sig { returns(String) }
|
4101
3536
|
attr_accessor :payment_method_collection
|
4102
|
-
|
4103
3537
|
# The ID of the payment method configuration to use with this Checkout session.
|
4104
3538
|
sig { returns(String) }
|
4105
3539
|
attr_accessor :payment_method_configuration
|
4106
|
-
|
4107
3540
|
# This parameter allows you to set some attributes on the payment method created during a Checkout session.
|
4108
3541
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodData) }
|
4109
3542
|
attr_accessor :payment_method_data
|
4110
|
-
|
4111
3543
|
# Payment-method-specific configuration.
|
4112
3544
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions) }
|
4113
3545
|
attr_accessor :payment_method_options
|
4114
|
-
|
4115
3546
|
# A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
|
4116
3547
|
#
|
4117
3548
|
# You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
|
@@ -4125,56 +3556,45 @@ module Stripe
|
|
4125
3556
|
# other characteristics.
|
4126
3557
|
sig { returns(T::Array[String]) }
|
4127
3558
|
attr_accessor :payment_method_types
|
4128
|
-
|
4129
3559
|
# This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
|
4130
3560
|
#
|
4131
3561
|
# For specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.
|
4132
3562
|
sig { returns(::Stripe::Checkout::Session::CreateParams::Permissions) }
|
4133
3563
|
attr_accessor :permissions
|
4134
|
-
|
4135
3564
|
# Controls phone number collection settings for the session.
|
4136
3565
|
#
|
4137
3566
|
# We recommend that you review your privacy policy and check with your legal contacts
|
4138
3567
|
# before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).
|
4139
3568
|
sig { returns(::Stripe::Checkout::Session::CreateParams::PhoneNumberCollection) }
|
4140
3569
|
attr_accessor :phone_number_collection
|
4141
|
-
|
4142
3570
|
# This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
|
4143
3571
|
sig { returns(String) }
|
4144
3572
|
attr_accessor :redirect_on_completion
|
4145
|
-
|
4146
3573
|
# The URL to redirect your customer back to after they authenticate or cancel their payment on the
|
4147
3574
|
# payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
|
4148
3575
|
# and redirect-based payment methods are enabled on the session.
|
4149
3576
|
sig { returns(String) }
|
4150
3577
|
attr_accessor :return_url
|
4151
|
-
|
4152
3578
|
# Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
|
4153
3579
|
sig { returns(::Stripe::Checkout::Session::CreateParams::SavedPaymentMethodOptions) }
|
4154
3580
|
attr_accessor :saved_payment_method_options
|
4155
|
-
|
4156
3581
|
# A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
|
4157
3582
|
sig { returns(::Stripe::Checkout::Session::CreateParams::SetupIntentData) }
|
4158
3583
|
attr_accessor :setup_intent_data
|
4159
|
-
|
4160
3584
|
# When set, provides configuration for Checkout to collect a shipping address from a customer.
|
4161
3585
|
sig { returns(::Stripe::Checkout::Session::CreateParams::ShippingAddressCollection) }
|
4162
3586
|
attr_accessor :shipping_address_collection
|
4163
|
-
|
4164
3587
|
# The shipping rate options to apply to this Session. Up to a maximum of 5.
|
4165
3588
|
sig { returns(T::Array[::Stripe::Checkout::Session::CreateParams::ShippingOption]) }
|
4166
3589
|
attr_accessor :shipping_options
|
4167
|
-
|
4168
3590
|
# Describes the type of transaction being performed by Checkout in order to customize
|
4169
3591
|
# relevant text on the page, such as the submit button. `submit_type` can only be
|
4170
3592
|
# specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
|
4171
3593
|
sig { returns(String) }
|
4172
3594
|
attr_accessor :submit_type
|
4173
|
-
|
4174
3595
|
# A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
|
4175
3596
|
sig { returns(::Stripe::Checkout::Session::CreateParams::SubscriptionData) }
|
4176
3597
|
attr_accessor :subscription_data
|
4177
|
-
|
4178
3598
|
# The URL to which Stripe should send customers when payment or setup
|
4179
3599
|
# is complete.
|
4180
3600
|
# This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
|
@@ -4182,15 +3602,12 @@ module Stripe
|
|
4182
3602
|
# guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
|
4183
3603
|
sig { returns(String) }
|
4184
3604
|
attr_accessor :success_url
|
4185
|
-
|
4186
3605
|
# Controls tax ID collection during checkout.
|
4187
3606
|
sig { returns(::Stripe::Checkout::Session::CreateParams::TaxIdCollection) }
|
4188
3607
|
attr_accessor :tax_id_collection
|
4189
|
-
|
4190
3608
|
# The UI mode of the Session. Defaults to `hosted`.
|
4191
3609
|
sig { returns(String) }
|
4192
3610
|
attr_accessor :ui_mode
|
4193
|
-
|
4194
3611
|
sig {
|
4195
3612
|
params(adaptive_pricing: ::Stripe::Checkout::Session::CreateParams::AdaptivePricing, after_expiration: ::Stripe::Checkout::Session::CreateParams::AfterExpiration, allow_promotion_codes: T::Boolean, automatic_tax: ::Stripe::Checkout::Session::CreateParams::AutomaticTax, billing_address_collection: String, cancel_url: String, client_reference_id: String, consent_collection: ::Stripe::Checkout::Session::CreateParams::ConsentCollection, currency: String, custom_fields: T::Array[::Stripe::Checkout::Session::CreateParams::CustomField], custom_text: ::Stripe::Checkout::Session::CreateParams::CustomText, customer: String, customer_creation: String, customer_email: String, customer_update: ::Stripe::Checkout::Session::CreateParams::CustomerUpdate, discounts: T::Array[::Stripe::Checkout::Session::CreateParams::Discount], expand: T::Array[String], expires_at: Integer, invoice_creation: ::Stripe::Checkout::Session::CreateParams::InvoiceCreation, line_items: T::Array[::Stripe::Checkout::Session::CreateParams::LineItem], locale: String, metadata: T::Hash[String, String], mode: String, payment_intent_data: ::Stripe::Checkout::Session::CreateParams::PaymentIntentData, payment_method_collection: String, payment_method_configuration: String, payment_method_data: ::Stripe::Checkout::Session::CreateParams::PaymentMethodData, payment_method_options: ::Stripe::Checkout::Session::CreateParams::PaymentMethodOptions, payment_method_types: T::Array[String], permissions: ::Stripe::Checkout::Session::CreateParams::Permissions, phone_number_collection: ::Stripe::Checkout::Session::CreateParams::PhoneNumberCollection, redirect_on_completion: String, return_url: String, saved_payment_method_options: ::Stripe::Checkout::Session::CreateParams::SavedPaymentMethodOptions, setup_intent_data: ::Stripe::Checkout::Session::CreateParams::SetupIntentData, shipping_address_collection: ::Stripe::Checkout::Session::CreateParams::ShippingAddressCollection, shipping_options: T::Array[::Stripe::Checkout::Session::CreateParams::ShippingOption], submit_type: String, subscription_data: ::Stripe::Checkout::Session::CreateParams::SubscriptionData, success_url: String, tax_id_collection: ::Stripe::Checkout::Session::CreateParams::TaxIdCollection, ui_mode: String).void
|
4196
3613
|
}
|
@@ -4243,7 +3660,6 @@ module Stripe
|
|
4243
3660
|
# Specifies which fields in the response should be expanded.
|
4244
3661
|
sig { returns(T::Array[String]) }
|
4245
3662
|
attr_accessor :expand
|
4246
|
-
|
4247
3663
|
sig { params(expand: T::Array[String]).void }
|
4248
3664
|
def initialize(expand: nil); end
|
4249
3665
|
end
|
@@ -4254,27 +3670,21 @@ module Stripe
|
|
4254
3670
|
# City, district, suburb, town, or village.
|
4255
3671
|
sig { returns(String) }
|
4256
3672
|
attr_accessor :city
|
4257
|
-
|
4258
3673
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
4259
3674
|
sig { returns(String) }
|
4260
3675
|
attr_accessor :country
|
4261
|
-
|
4262
3676
|
# Address line 1 (e.g., street, PO Box, or company name).
|
4263
3677
|
sig { returns(String) }
|
4264
3678
|
attr_accessor :line1
|
4265
|
-
|
4266
3679
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
4267
3680
|
sig { returns(String) }
|
4268
3681
|
attr_accessor :line2
|
4269
|
-
|
4270
3682
|
# ZIP or postal code.
|
4271
3683
|
sig { returns(String) }
|
4272
3684
|
attr_accessor :postal_code
|
4273
|
-
|
4274
3685
|
# State, county, province, or region.
|
4275
3686
|
sig { returns(String) }
|
4276
3687
|
attr_accessor :state
|
4277
|
-
|
4278
3688
|
sig {
|
4279
3689
|
params(city: String, country: String, line1: String, line2: String, postal_code: String, state: String).void
|
4280
3690
|
}
|
@@ -4292,11 +3702,9 @@ module Stripe
|
|
4292
3702
|
returns(::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails::Address)
|
4293
3703
|
}
|
4294
3704
|
attr_accessor :address
|
4295
|
-
|
4296
3705
|
# The name of customer
|
4297
3706
|
sig { returns(String) }
|
4298
3707
|
attr_accessor :name
|
4299
|
-
|
4300
3708
|
sig {
|
4301
3709
|
params(address: ::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails::Address, name: String).void
|
4302
3710
|
}
|
@@ -4307,7 +3715,6 @@ module Stripe
|
|
4307
3715
|
returns(::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails)
|
4308
3716
|
}
|
4309
3717
|
attr_accessor :shipping_details
|
4310
|
-
|
4311
3718
|
sig {
|
4312
3719
|
params(shipping_details: ::Stripe::Checkout::Session::UpdateParams::CollectedInformation::ShippingDetails).void
|
4313
3720
|
}
|
@@ -4318,42 +3725,33 @@ module Stripe
|
|
4318
3725
|
# Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
|
4319
3726
|
sig { returns(T::Boolean) }
|
4320
3727
|
attr_accessor :enabled
|
4321
|
-
|
4322
3728
|
# The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
|
4323
3729
|
sig { returns(Integer) }
|
4324
3730
|
attr_accessor :maximum
|
4325
|
-
|
4326
3731
|
# The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
|
4327
3732
|
sig { returns(Integer) }
|
4328
3733
|
attr_accessor :minimum
|
4329
|
-
|
4330
3734
|
sig { params(enabled: T::Boolean, maximum: Integer, minimum: Integer).void }
|
4331
3735
|
def initialize(enabled: nil, maximum: nil, minimum: nil); end
|
4332
3736
|
end
|
4333
3737
|
# When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
|
4334
3738
|
sig { returns(::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity) }
|
4335
3739
|
attr_accessor :adjustable_quantity
|
4336
|
-
|
4337
3740
|
# ID of an existing line item.
|
4338
3741
|
sig { returns(String) }
|
4339
3742
|
attr_accessor :id
|
4340
|
-
|
4341
3743
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
4342
3744
|
sig { returns(T.nilable(T::Hash[String, String])) }
|
4343
3745
|
attr_accessor :metadata
|
4344
|
-
|
4345
3746
|
# The ID of the [Price](https://stripe.com/docs/api/prices).
|
4346
3747
|
sig { returns(String) }
|
4347
3748
|
attr_accessor :price
|
4348
|
-
|
4349
3749
|
# The quantity of the line item being purchased.
|
4350
3750
|
sig { returns(Integer) }
|
4351
3751
|
attr_accessor :quantity
|
4352
|
-
|
4353
3752
|
# The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
|
4354
3753
|
sig { returns(T.nilable(T::Array[String])) }
|
4355
3754
|
attr_accessor :tax_rates
|
4356
|
-
|
4357
3755
|
sig {
|
4358
3756
|
params(adjustable_quantity: ::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity, id: String, metadata: T.nilable(T::Hash[String, String]), price: String, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
|
4359
3757
|
}
|
@@ -4373,11 +3771,9 @@ module Stripe
|
|
4373
3771
|
# A unit of time.
|
4374
3772
|
sig { returns(String) }
|
4375
3773
|
attr_accessor :unit
|
4376
|
-
|
4377
3774
|
# Must be greater than 0.
|
4378
3775
|
sig { returns(Integer) }
|
4379
3776
|
attr_accessor :value
|
4380
|
-
|
4381
3777
|
sig { params(unit: String, value: Integer).void }
|
4382
3778
|
def initialize(unit: nil, value: nil); end
|
4383
3779
|
end
|
@@ -4385,11 +3781,9 @@ module Stripe
|
|
4385
3781
|
# A unit of time.
|
4386
3782
|
sig { returns(String) }
|
4387
3783
|
attr_accessor :unit
|
4388
|
-
|
4389
3784
|
# Must be greater than 0.
|
4390
3785
|
sig { returns(Integer) }
|
4391
3786
|
attr_accessor :value
|
4392
|
-
|
4393
3787
|
sig { params(unit: String, value: Integer).void }
|
4394
3788
|
def initialize(unit: nil, value: nil); end
|
4395
3789
|
end
|
@@ -4398,13 +3792,11 @@ module Stripe
|
|
4398
3792
|
returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum)
|
4399
3793
|
}
|
4400
3794
|
attr_accessor :maximum
|
4401
|
-
|
4402
3795
|
# The lower bound of the estimated range. If empty, represents no lower bound.
|
4403
3796
|
sig {
|
4404
3797
|
returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum)
|
4405
3798
|
}
|
4406
3799
|
attr_accessor :minimum
|
4407
|
-
|
4408
3800
|
sig {
|
4409
3801
|
params(maximum: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Maximum, minimum: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate::Minimum).void
|
4410
3802
|
}
|
@@ -4415,28 +3807,23 @@ module Stripe
|
|
4415
3807
|
# A non-negative integer in cents representing how much to charge.
|
4416
3808
|
sig { returns(Integer) }
|
4417
3809
|
attr_accessor :amount
|
4418
|
-
|
4419
3810
|
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
4420
3811
|
sig { returns(String) }
|
4421
3812
|
attr_accessor :tax_behavior
|
4422
|
-
|
4423
3813
|
sig { params(amount: Integer, tax_behavior: String).void }
|
4424
3814
|
def initialize(amount: nil, tax_behavior: nil); end
|
4425
3815
|
end
|
4426
3816
|
# A non-negative integer in cents representing how much to charge.
|
4427
3817
|
sig { returns(Integer) }
|
4428
3818
|
attr_accessor :amount
|
4429
|
-
|
4430
3819
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
4431
3820
|
sig { returns(String) }
|
4432
3821
|
attr_accessor :currency
|
4433
|
-
|
4434
3822
|
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
|
4435
3823
|
sig {
|
4436
3824
|
returns(T::Hash[String, ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions])
|
4437
3825
|
}
|
4438
3826
|
attr_accessor :currency_options
|
4439
|
-
|
4440
3827
|
sig {
|
4441
3828
|
params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount::CurrencyOptions]).void
|
4442
3829
|
}
|
@@ -4447,33 +3834,26 @@ module Stripe
|
|
4447
3834
|
returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate)
|
4448
3835
|
}
|
4449
3836
|
attr_accessor :delivery_estimate
|
4450
|
-
|
4451
3837
|
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
|
4452
3838
|
sig { returns(String) }
|
4453
3839
|
attr_accessor :display_name
|
4454
|
-
|
4455
3840
|
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
|
4456
3841
|
sig {
|
4457
3842
|
returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount)
|
4458
3843
|
}
|
4459
3844
|
attr_accessor :fixed_amount
|
4460
|
-
|
4461
3845
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
4462
3846
|
sig { returns(T::Hash[String, String]) }
|
4463
3847
|
attr_accessor :metadata
|
4464
|
-
|
4465
3848
|
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
4466
3849
|
sig { returns(String) }
|
4467
3850
|
attr_accessor :tax_behavior
|
4468
|
-
|
4469
3851
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
|
4470
3852
|
sig { returns(String) }
|
4471
3853
|
attr_accessor :tax_code
|
4472
|
-
|
4473
3854
|
# The type of calculation to use on the shipping rate.
|
4474
3855
|
sig { returns(String) }
|
4475
3856
|
attr_accessor :type
|
4476
|
-
|
4477
3857
|
sig {
|
4478
3858
|
params(delivery_estimate: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::DeliveryEstimate, display_name: String, fixed_amount: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData::FixedAmount, metadata: T::Hash[String, String], tax_behavior: String, tax_code: String, type: String).void
|
4479
3859
|
}
|
@@ -4490,13 +3870,11 @@ module Stripe
|
|
4490
3870
|
# The ID of the Shipping Rate to use for this shipping option.
|
4491
3871
|
sig { returns(String) }
|
4492
3872
|
attr_accessor :shipping_rate
|
4493
|
-
|
4494
3873
|
# Parameters to be passed to Shipping Rate creation for this shipping option.
|
4495
3874
|
sig {
|
4496
3875
|
returns(::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData)
|
4497
3876
|
}
|
4498
3877
|
attr_accessor :shipping_rate_data
|
4499
|
-
|
4500
3878
|
sig {
|
4501
3879
|
params(shipping_rate: String, shipping_rate_data: ::Stripe::Checkout::Session::UpdateParams::ShippingOption::ShippingRateData).void
|
4502
3880
|
}
|
@@ -4505,11 +3883,9 @@ module Stripe
|
|
4505
3883
|
# Information about the customer collected within the Checkout Session.
|
4506
3884
|
sig { returns(::Stripe::Checkout::Session::UpdateParams::CollectedInformation) }
|
4507
3885
|
attr_accessor :collected_information
|
4508
|
-
|
4509
3886
|
# Specifies which fields in the response should be expanded.
|
4510
3887
|
sig { returns(T::Array[String]) }
|
4511
3888
|
attr_accessor :expand
|
4512
|
-
|
4513
3889
|
# A list of items the customer is purchasing.
|
4514
3890
|
#
|
4515
3891
|
# When updating line items, you must retransmit the entire array of line items.
|
@@ -4525,17 +3901,14 @@ module Stripe
|
|
4525
3901
|
# To reorder a line item, specify it at the desired position in the retransmitted array.
|
4526
3902
|
sig { returns(T::Array[::Stripe::Checkout::Session::UpdateParams::LineItem]) }
|
4527
3903
|
attr_accessor :line_items
|
4528
|
-
|
4529
3904
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
4530
3905
|
sig { returns(T.nilable(T::Hash[String, String])) }
|
4531
3906
|
attr_accessor :metadata
|
4532
|
-
|
4533
3907
|
# The shipping rate options to apply to this Session. Up to a maximum of 5.
|
4534
3908
|
sig {
|
4535
3909
|
returns(T.nilable(T::Array[::Stripe::Checkout::Session::UpdateParams::ShippingOption]))
|
4536
3910
|
}
|
4537
3911
|
attr_accessor :shipping_options
|
4538
|
-
|
4539
3912
|
sig {
|
4540
3913
|
params(collected_information: ::Stripe::Checkout::Session::UpdateParams::CollectedInformation, expand: T::Array[String], line_items: T::Array[::Stripe::Checkout::Session::UpdateParams::LineItem], metadata: T.nilable(T::Hash[String, String]), shipping_options: T.nilable(T::Array[::Stripe::Checkout::Session::UpdateParams::ShippingOption])).void
|
4541
3914
|
}
|
@@ -4551,19 +3924,15 @@ module Stripe
|
|
4551
3924
|
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
4552
3925
|
sig { returns(String) }
|
4553
3926
|
attr_accessor :ending_before
|
4554
|
-
|
4555
3927
|
# Specifies which fields in the response should be expanded.
|
4556
3928
|
sig { returns(T::Array[String]) }
|
4557
3929
|
attr_accessor :expand
|
4558
|
-
|
4559
3930
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
4560
3931
|
sig { returns(Integer) }
|
4561
3932
|
attr_accessor :limit
|
4562
|
-
|
4563
3933
|
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
4564
3934
|
sig { returns(String) }
|
4565
3935
|
attr_accessor :starting_after
|
4566
|
-
|
4567
3936
|
sig {
|
4568
3937
|
params(ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String).void
|
4569
3938
|
}
|
@@ -4573,7 +3942,6 @@ module Stripe
|
|
4573
3942
|
# Specifies which fields in the response should be expanded.
|
4574
3943
|
sig { returns(T::Array[String]) }
|
4575
3944
|
attr_accessor :expand
|
4576
|
-
|
4577
3945
|
sig { params(expand: T::Array[String]).void }
|
4578
3946
|
def initialize(expand: nil); end
|
4579
3947
|
end
|