stripe 13.4.0.pre.beta.1 → 13.4.0.pre.beta.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +24 -1
- data/CONTRIBUTING.md +25 -0
- data/Makefile +2 -0
- data/OPENAPI_VERSION +1 -1
- data/README.md +11 -6
- data/Rakefile +0 -5
- data/VERSION +1 -1
- data/justfile +43 -0
- data/lib/stripe/api_version.rb +1 -1
- data/lib/stripe/resources/account.rb +117 -747
- 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 +93 -128
- 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 +2 -79
- 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 +8 -665
- data/lib/stripe/resources/checkout/session.rb +21 -513
- 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 +12 -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 +1 -22
- 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 +48 -1768
- data/lib/stripe/resources/payment_link.rb +15 -213
- data/lib/stripe/resources/payment_method.rb +19 -345
- data/lib/stripe/resources/payment_method_configuration.rb +58 -292
- 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 +23 -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 +46 -161
- 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 +23 -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 +100 -521
- data/lib/stripe/services/account_session_service.rb +22 -80
- 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 +2 -50
- 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 +9 -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 +1 -10
- 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 +42 -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 +42 -102
- data/lib/stripe/services/payment_method_domain_service.rb +0 -8
- data/lib/stripe/services/payment_method_service.rb +14 -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 +21 -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 +36 -106
- 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 +7 -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 +23 -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 +7 -2
- data/lib/stripe/stripe_configuration.rb +21 -1
- data/lib/stripe/stripe_object.rb +3 -3
- data/lib/stripe/thin_event.rb +22 -2
- data/lib/stripe/util.rb +1 -1
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe.rb +22 -0
- data/rbi/stripe/resources/account.rbi +120 -1007
- 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 +121 -172
- 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 +2 -108
- 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 +10 -738
- data/rbi/stripe/resources/checkout/session.rbi +26 -638
- 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 +15 -365
- 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 +1 -27
- 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 +61 -2230
- data/rbi/stripe/resources/payment_link.rbi +14 -291
- data/rbi/stripe/resources/payment_method.rbi +23 -384
- data/rbi/stripe/resources/payment_method_configuration.rbi +75 -495
- 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 +27 -691
- 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 +54 -213
- 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 +22 -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 +98 -779
- data/rbi/stripe/services/account_session_service.rbi +29 -122
- 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 +2 -78
- 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 +12 -396
- 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 +1 -14
- 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 +54 -1770
- 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 +46 -296
- data/rbi/stripe/services/payment_method_domain_service.rbi +0 -13
- data/rbi/stripe/services/payment_method_service.rbi +16 -151
- 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 +24 -598
- 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 +40 -156
- 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 +10 -115
- 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 +24 -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 +4 -2
@@ -36,15 +36,12 @@ module Stripe
|
|
36
36
|
class Recovery < Stripe::StripeObject
|
37
37
|
# Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
|
38
38
|
attr_reader :allow_promotion_codes
|
39
|
-
|
40
39
|
# If `true`, a recovery url will be generated to recover this Checkout Session if it
|
41
40
|
# expires before a transaction is completed. It will be attached to the
|
42
41
|
# Checkout Session object upon expiration.
|
43
42
|
attr_reader :enabled
|
44
|
-
|
45
43
|
# The timestamp at which the recovery URL will expire.
|
46
44
|
attr_reader :expires_at
|
47
|
-
|
48
45
|
# URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session
|
49
46
|
attr_reader :url
|
50
47
|
end
|
@@ -56,16 +53,13 @@ module Stripe
|
|
56
53
|
class Liability < Stripe::StripeObject
|
57
54
|
# The connected account being referenced when `type` is `account`.
|
58
55
|
attr_reader :account
|
59
|
-
|
60
56
|
# Type of the account referenced.
|
61
57
|
attr_reader :type
|
62
58
|
end
|
63
59
|
# Indicates whether automatic tax is enabled for the session
|
64
60
|
attr_reader :enabled
|
65
|
-
|
66
61
|
# 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.
|
67
62
|
attr_reader :liability
|
68
|
-
|
69
63
|
# The status of the most recent automated tax calculation for this session.
|
70
64
|
attr_reader :status
|
71
65
|
end
|
@@ -75,57 +69,43 @@ module Stripe
|
|
75
69
|
class Address < Stripe::StripeObject
|
76
70
|
# City, district, suburb, town, or village.
|
77
71
|
attr_reader :city
|
78
|
-
|
79
72
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
80
73
|
attr_reader :country
|
81
|
-
|
82
74
|
# Address line 1 (e.g., street, PO Box, or company name).
|
83
75
|
attr_reader :line1
|
84
|
-
|
85
76
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
86
77
|
attr_reader :line2
|
87
|
-
|
88
78
|
# ZIP or postal code.
|
89
79
|
attr_reader :postal_code
|
90
|
-
|
91
80
|
# State, county, province, or region.
|
92
81
|
attr_reader :state
|
93
82
|
end
|
94
83
|
# Attribute for field address
|
95
84
|
attr_reader :address
|
96
|
-
|
97
85
|
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
|
98
86
|
attr_reader :carrier
|
99
|
-
|
100
87
|
# Recipient name.
|
101
88
|
attr_reader :name
|
102
|
-
|
103
89
|
# Recipient phone (including extension).
|
104
90
|
attr_reader :phone
|
105
|
-
|
106
91
|
# 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.
|
107
92
|
attr_reader :tracking_number
|
108
93
|
end
|
109
94
|
|
110
95
|
class TaxId < Stripe::StripeObject
|
111
|
-
# 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`
|
96
|
+
# 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`
|
112
97
|
attr_reader :type
|
113
|
-
|
114
98
|
# The value of the tax ID.
|
115
99
|
attr_reader :value
|
116
100
|
end
|
117
101
|
# Customer’s business name for this Checkout Session
|
118
102
|
attr_reader :business_name
|
119
|
-
|
120
103
|
# Customer’s email for this Checkout Session
|
121
104
|
attr_reader :email
|
122
|
-
|
123
105
|
# Customer’s phone number for this Checkout Session
|
124
106
|
attr_reader :phone
|
125
|
-
|
126
107
|
# Shipping information for this Checkout Session.
|
127
108
|
attr_reader :shipping_details
|
128
|
-
|
129
109
|
# Customer’s tax ids for this Checkout Session.
|
130
110
|
attr_reader :tax_ids
|
131
111
|
end
|
@@ -134,7 +114,6 @@ module Stripe
|
|
134
114
|
# If `opt_in`, the customer consents to receiving promotional communications
|
135
115
|
# from the merchant about this Checkout Session.
|
136
116
|
attr_reader :promotions
|
137
|
-
|
138
117
|
# If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.
|
139
118
|
attr_reader :terms_of_service
|
140
119
|
end
|
@@ -148,12 +127,10 @@ module Stripe
|
|
148
127
|
end
|
149
128
|
# If set to `hidden`, it will hide legal text related to the reuse of a payment method.
|
150
129
|
attr_reader :payment_method_reuse_agreement
|
151
|
-
|
152
130
|
# If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
|
153
131
|
# Session will determine whether to display an option to opt into promotional communication
|
154
132
|
# from the merchant depending on the customer's locale. Only available to US merchants.
|
155
133
|
attr_reader :promotions
|
156
|
-
|
157
134
|
# If set to `required`, it requires customers to accept the terms of service before being able to pay.
|
158
135
|
attr_reader :terms_of_service
|
159
136
|
end
|
@@ -161,13 +138,10 @@ module Stripe
|
|
161
138
|
class CurrencyConversion < Stripe::StripeObject
|
162
139
|
# Total of all items in source currency before discounts or taxes are applied.
|
163
140
|
attr_reader :amount_subtotal
|
164
|
-
|
165
141
|
# Total of all items in source currency after discounts and taxes are applied.
|
166
142
|
attr_reader :amount_total
|
167
|
-
|
168
143
|
# Exchange rate used to convert source currency amounts to customer currency amounts
|
169
144
|
attr_reader :fx_rate
|
170
|
-
|
171
145
|
# Creation currency of the CheckoutSession before localization
|
172
146
|
attr_reader :source_currency
|
173
147
|
end
|
@@ -177,16 +151,13 @@ module Stripe
|
|
177
151
|
class Option < Stripe::StripeObject
|
178
152
|
# The label for the option, displayed to the customer. Up to 100 characters.
|
179
153
|
attr_reader :label
|
180
|
-
|
181
154
|
# 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.
|
182
155
|
attr_reader :value
|
183
156
|
end
|
184
157
|
# The value that will pre-fill on the payment page.
|
185
158
|
attr_reader :default_value
|
186
|
-
|
187
159
|
# The options available for the customer to select. Up to 200 options allowed.
|
188
160
|
attr_reader :options
|
189
|
-
|
190
161
|
# The option selected by the customer. This will be the `value` for the option.
|
191
162
|
attr_reader :value
|
192
163
|
end
|
@@ -194,7 +165,6 @@ module Stripe
|
|
194
165
|
class Label < Stripe::StripeObject
|
195
166
|
# Custom text for the label, displayed to the customer. Up to 50 characters.
|
196
167
|
attr_reader :custom
|
197
|
-
|
198
168
|
# The type of the label.
|
199
169
|
attr_reader :type
|
200
170
|
end
|
@@ -202,13 +172,10 @@ module Stripe
|
|
202
172
|
class Numeric < Stripe::StripeObject
|
203
173
|
# The value that will pre-fill the field on the payment page.
|
204
174
|
attr_reader :default_value
|
205
|
-
|
206
175
|
# The maximum character length constraint for the customer's input.
|
207
176
|
attr_reader :maximum_length
|
208
|
-
|
209
177
|
# The minimum character length requirement for the customer's input.
|
210
178
|
attr_reader :minimum_length
|
211
|
-
|
212
179
|
# The value entered by the customer, containing only digits.
|
213
180
|
attr_reader :value
|
214
181
|
end
|
@@ -216,34 +183,25 @@ module Stripe
|
|
216
183
|
class Text < Stripe::StripeObject
|
217
184
|
# The value that will pre-fill the field on the payment page.
|
218
185
|
attr_reader :default_value
|
219
|
-
|
220
186
|
# The maximum character length constraint for the customer's input.
|
221
187
|
attr_reader :maximum_length
|
222
|
-
|
223
188
|
# The minimum character length requirement for the customer's input.
|
224
189
|
attr_reader :minimum_length
|
225
|
-
|
226
190
|
# The value entered by the customer.
|
227
191
|
attr_reader :value
|
228
192
|
end
|
229
193
|
# Attribute for field dropdown
|
230
194
|
attr_reader :dropdown
|
231
|
-
|
232
195
|
# 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.
|
233
196
|
attr_reader :key
|
234
|
-
|
235
197
|
# Attribute for field label
|
236
198
|
attr_reader :label
|
237
|
-
|
238
199
|
# Attribute for field numeric
|
239
200
|
attr_reader :numeric
|
240
|
-
|
241
201
|
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
|
242
202
|
attr_reader :optional
|
243
|
-
|
244
203
|
# Attribute for field text
|
245
204
|
attr_reader :text
|
246
|
-
|
247
205
|
# The type of the field.
|
248
206
|
attr_reader :type
|
249
207
|
end
|
@@ -270,13 +228,10 @@ module Stripe
|
|
270
228
|
end
|
271
229
|
# Custom text that should be displayed after the payment confirmation button.
|
272
230
|
attr_reader :after_submit
|
273
|
-
|
274
231
|
# Custom text that should be displayed alongside shipping address collection.
|
275
232
|
attr_reader :shipping_address
|
276
|
-
|
277
233
|
# Custom text that should be displayed alongside the payment confirmation button.
|
278
234
|
attr_reader :submit
|
279
|
-
|
280
235
|
# Custom text that should be displayed in place of the default terms of service agreement text.
|
281
236
|
attr_reader :terms_of_service_acceptance
|
282
237
|
end
|
@@ -285,56 +240,51 @@ module Stripe
|
|
285
240
|
class Address < Stripe::StripeObject
|
286
241
|
# City, district, suburb, town, or village.
|
287
242
|
attr_reader :city
|
288
|
-
|
289
243
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
290
244
|
attr_reader :country
|
291
|
-
|
292
245
|
# Address line 1 (e.g., street, PO Box, or company name).
|
293
246
|
attr_reader :line1
|
294
|
-
|
295
247
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
296
248
|
attr_reader :line2
|
297
|
-
|
298
249
|
# ZIP or postal code.
|
299
250
|
attr_reader :postal_code
|
300
|
-
|
301
251
|
# State, county, province, or region.
|
302
252
|
attr_reader :state
|
303
253
|
end
|
304
254
|
|
305
255
|
class TaxId < Stripe::StripeObject
|
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`, `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`
|
256
|
+
# 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`
|
307
257
|
attr_reader :type
|
308
|
-
|
309
258
|
# The value of the tax ID.
|
310
259
|
attr_reader :value
|
311
260
|
end
|
312
261
|
# The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
|
313
262
|
attr_reader :address
|
314
|
-
|
315
263
|
# The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.
|
316
264
|
# 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.
|
317
265
|
attr_reader :email
|
318
|
-
|
319
266
|
# The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
|
320
267
|
attr_reader :name
|
321
|
-
|
322
268
|
# The customer's phone number after a completed Checkout Session.
|
323
269
|
attr_reader :phone
|
324
|
-
|
325
270
|
# The customer’s tax exempt status after a completed Checkout Session.
|
326
271
|
attr_reader :tax_exempt
|
327
|
-
|
328
272
|
# The customer’s tax IDs after a completed Checkout Session.
|
329
273
|
attr_reader :tax_ids
|
330
274
|
end
|
331
275
|
|
276
|
+
class Discount < Stripe::StripeObject
|
277
|
+
# Coupon attached to the Checkout Session.
|
278
|
+
attr_reader :coupon
|
279
|
+
# Promotion code attached to the Checkout Session.
|
280
|
+
attr_reader :promotion_code
|
281
|
+
end
|
282
|
+
|
332
283
|
class InvoiceCreation < Stripe::StripeObject
|
333
284
|
class InvoiceData < Stripe::StripeObject
|
334
285
|
class CustomField < Stripe::StripeObject
|
335
286
|
# The name of the custom field.
|
336
287
|
attr_reader :name
|
337
|
-
|
338
288
|
# The value of the custom field.
|
339
289
|
attr_reader :value
|
340
290
|
end
|
@@ -342,7 +292,6 @@ module Stripe
|
|
342
292
|
class Issuer < Stripe::StripeObject
|
343
293
|
# The connected account being referenced when `type` is `account`.
|
344
294
|
attr_reader :account
|
345
|
-
|
346
295
|
# Type of the account referenced.
|
347
296
|
attr_reader :type
|
348
297
|
end
|
@@ -353,28 +302,21 @@ module Stripe
|
|
353
302
|
end
|
354
303
|
# The account tax IDs associated with the invoice.
|
355
304
|
attr_reader :account_tax_ids
|
356
|
-
|
357
305
|
# Custom fields displayed on the invoice.
|
358
306
|
attr_reader :custom_fields
|
359
|
-
|
360
307
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
361
308
|
attr_reader :description
|
362
|
-
|
363
309
|
# Footer displayed on the invoice.
|
364
310
|
attr_reader :footer
|
365
|
-
|
366
311
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
367
312
|
attr_reader :issuer
|
368
|
-
|
369
313
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
370
314
|
attr_reader :metadata
|
371
|
-
|
372
315
|
# Options for invoice PDF rendering.
|
373
316
|
attr_reader :rendering_options
|
374
317
|
end
|
375
318
|
# Indicates whether invoice creation is enabled for the Checkout Session.
|
376
319
|
attr_reader :enabled
|
377
|
-
|
378
320
|
# Attribute for field invoice_data
|
379
321
|
attr_reader :invoice_data
|
380
322
|
end
|
@@ -382,7 +324,6 @@ module Stripe
|
|
382
324
|
class PaymentMethodConfigurationDetails < Stripe::StripeObject
|
383
325
|
# ID of the payment method configuration used.
|
384
326
|
attr_reader :id
|
385
|
-
|
386
327
|
# ID of the parent payment method configuration used.
|
387
328
|
attr_reader :parent
|
388
329
|
end
|
@@ -392,25 +333,19 @@ module Stripe
|
|
392
333
|
class MandateOptions < Stripe::StripeObject
|
393
334
|
# A URL for custom mandate text
|
394
335
|
attr_reader :custom_mandate_url
|
395
|
-
|
396
336
|
# List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.
|
397
337
|
attr_reader :default_for
|
398
|
-
|
399
338
|
# Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
|
400
339
|
attr_reader :interval_description
|
401
|
-
|
402
340
|
# Payment schedule for the mandate.
|
403
341
|
attr_reader :payment_schedule
|
404
|
-
|
405
342
|
# Transaction type of the mandate.
|
406
343
|
attr_reader :transaction_type
|
407
344
|
end
|
408
345
|
# Currency supported by the bank account. Returned when the Session is in `setup` mode.
|
409
346
|
attr_reader :currency
|
410
|
-
|
411
347
|
# Attribute for field mandate_options
|
412
348
|
attr_reader :mandate_options
|
413
|
-
|
414
349
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
415
350
|
#
|
416
351
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -419,7 +354,6 @@ module Stripe
|
|
419
354
|
#
|
420
355
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
421
356
|
attr_reader :setup_future_usage
|
422
|
-
|
423
357
|
# Bank account verification method.
|
424
358
|
attr_reader :verification_method
|
425
359
|
end
|
@@ -486,7 +420,6 @@ module Stripe
|
|
486
420
|
end
|
487
421
|
# Attribute for field mandate_options
|
488
422
|
attr_reader :mandate_options
|
489
|
-
|
490
423
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
491
424
|
#
|
492
425
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -511,7 +444,6 @@ module Stripe
|
|
511
444
|
class Boleto < Stripe::StripeObject
|
512
445
|
# 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.
|
513
446
|
attr_reader :expires_after_days
|
514
|
-
|
515
447
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
516
448
|
#
|
517
449
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -529,25 +461,18 @@ module Stripe
|
|
529
461
|
end
|
530
462
|
# Attribute for field installments
|
531
463
|
attr_reader :installments
|
532
|
-
|
533
464
|
# Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
|
534
465
|
attr_reader :request_decremental_authorization
|
535
|
-
|
536
466
|
# Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
|
537
467
|
attr_reader :request_extended_authorization
|
538
|
-
|
539
468
|
# Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
|
540
469
|
attr_reader :request_incremental_authorization
|
541
|
-
|
542
470
|
# Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
|
543
471
|
attr_reader :request_multicapture
|
544
|
-
|
545
472
|
# Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
|
546
473
|
attr_reader :request_overcapture
|
547
|
-
|
548
474
|
# 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.
|
549
475
|
attr_reader :request_three_d_secure
|
550
|
-
|
551
476
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
552
477
|
#
|
553
478
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -556,10 +481,8 @@ module Stripe
|
|
556
481
|
#
|
557
482
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
558
483
|
attr_reader :setup_future_usage
|
559
|
-
|
560
484
|
# 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.
|
561
485
|
attr_reader :statement_descriptor_suffix_kana
|
562
|
-
|
563
486
|
# 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.
|
564
487
|
attr_reader :statement_descriptor_suffix_kanji
|
565
488
|
end
|
@@ -583,21 +506,17 @@ module Stripe
|
|
583
506
|
end
|
584
507
|
# Attribute for field eu_bank_transfer
|
585
508
|
attr_reader :eu_bank_transfer
|
586
|
-
|
587
509
|
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
|
588
510
|
#
|
589
511
|
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
|
590
512
|
attr_reader :requested_address_types
|
591
|
-
|
592
513
|
# 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`.
|
593
514
|
attr_reader :type
|
594
515
|
end
|
595
516
|
# Attribute for field bank_transfer
|
596
517
|
attr_reader :bank_transfer
|
597
|
-
|
598
518
|
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
|
599
519
|
attr_reader :funding_type
|
600
|
-
|
601
520
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
602
521
|
#
|
603
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.
|
@@ -666,7 +585,6 @@ module Stripe
|
|
666
585
|
class KakaoPay < Stripe::StripeObject
|
667
586
|
# Controls when the funds will be captured from the customer's account.
|
668
587
|
attr_reader :capture_method
|
669
|
-
|
670
588
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
671
589
|
#
|
672
590
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -691,7 +609,6 @@ module Stripe
|
|
691
609
|
class Konbini < Stripe::StripeObject
|
692
610
|
# 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.
|
693
611
|
attr_reader :expires_after_days
|
694
|
-
|
695
612
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
696
613
|
#
|
697
614
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -705,7 +622,6 @@ module Stripe
|
|
705
622
|
class KrCard < Stripe::StripeObject
|
706
623
|
# Controls when the funds will be captured from the customer's account.
|
707
624
|
attr_reader :capture_method
|
708
|
-
|
709
625
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
710
626
|
#
|
711
627
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -757,7 +673,6 @@ module Stripe
|
|
757
673
|
class Oxxo < Stripe::StripeObject
|
758
674
|
# 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.
|
759
675
|
attr_reader :expires_after_days
|
760
|
-
|
761
676
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
762
677
|
#
|
763
678
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -798,13 +713,10 @@ module Stripe
|
|
798
713
|
class Paypal < Stripe::StripeObject
|
799
714
|
# Controls when the funds will be captured from the customer's account.
|
800
715
|
attr_reader :capture_method
|
801
|
-
|
802
716
|
# Preferred locale of the PayPal checkout page that the customer is redirected to.
|
803
717
|
attr_reader :preferred_locale
|
804
|
-
|
805
718
|
# 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.
|
806
719
|
attr_reader :reference
|
807
|
-
|
808
720
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
809
721
|
#
|
810
722
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -813,7 +725,6 @@ module Stripe
|
|
813
725
|
#
|
814
726
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
815
727
|
attr_reader :setup_future_usage
|
816
|
-
|
817
728
|
# 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.
|
818
729
|
attr_reader :subsellers
|
819
730
|
end
|
@@ -822,28 +733,21 @@ module Stripe
|
|
822
733
|
class MandateOptions < Stripe::StripeObject
|
823
734
|
# Amount that will be collected. It is required when `amount_type` is `fixed`.
|
824
735
|
attr_reader :amount
|
825
|
-
|
826
736
|
# 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.
|
827
737
|
attr_reader :amount_type
|
828
|
-
|
829
738
|
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
830
739
|
attr_reader :end_date
|
831
|
-
|
832
740
|
# The periodicity at which payments will be collected.
|
833
741
|
attr_reader :payment_schedule
|
834
|
-
|
835
742
|
# 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.
|
836
743
|
attr_reader :payments_per_period
|
837
|
-
|
838
744
|
# The purpose for which payments are made. Defaults to retail.
|
839
745
|
attr_reader :purpose
|
840
|
-
|
841
746
|
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
842
747
|
attr_reader :start_date
|
843
748
|
end
|
844
749
|
# Attribute for field mandate_options
|
845
750
|
attr_reader :mandate_options
|
846
|
-
|
847
751
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
848
752
|
#
|
849
753
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -882,7 +786,6 @@ module Stripe
|
|
882
786
|
end
|
883
787
|
# Attribute for field mandate_options
|
884
788
|
attr_reader :mandate_options
|
885
|
-
|
886
789
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
887
790
|
#
|
888
791
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -914,7 +817,6 @@ module Stripe
|
|
914
817
|
class Filters < Stripe::StripeObject
|
915
818
|
# The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
|
916
819
|
attr_reader :account_subcategories
|
917
|
-
|
918
820
|
# The institution to use to filter for possible accounts to link.
|
919
821
|
attr_reader :institution
|
920
822
|
end
|
@@ -925,22 +827,17 @@ module Stripe
|
|
925
827
|
end
|
926
828
|
# Attribute for field filters
|
927
829
|
attr_reader :filters
|
928
|
-
|
929
830
|
# Attribute for field manual_entry
|
930
831
|
attr_reader :manual_entry
|
931
|
-
|
932
832
|
# The list of permissions to request. The `payment_method` permission must be included.
|
933
833
|
attr_reader :permissions
|
934
|
-
|
935
834
|
# Data features requested to be retrieved upon account creation.
|
936
835
|
attr_reader :prefetch
|
937
|
-
|
938
836
|
# 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.
|
939
837
|
attr_reader :return_url
|
940
838
|
end
|
941
839
|
# Attribute for field financial_connections
|
942
840
|
attr_reader :financial_connections
|
943
|
-
|
944
841
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
945
842
|
#
|
946
843
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -949,121 +846,83 @@ module Stripe
|
|
949
846
|
#
|
950
847
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
951
848
|
attr_reader :setup_future_usage
|
952
|
-
|
953
849
|
# Bank account verification method.
|
954
850
|
attr_reader :verification_method
|
955
851
|
end
|
956
852
|
# Attribute for field acss_debit
|
957
853
|
attr_reader :acss_debit
|
958
|
-
|
959
854
|
# Attribute for field affirm
|
960
855
|
attr_reader :affirm
|
961
|
-
|
962
856
|
# Attribute for field afterpay_clearpay
|
963
857
|
attr_reader :afterpay_clearpay
|
964
|
-
|
965
858
|
# Attribute for field alipay
|
966
859
|
attr_reader :alipay
|
967
|
-
|
968
860
|
# Attribute for field amazon_pay
|
969
861
|
attr_reader :amazon_pay
|
970
|
-
|
971
862
|
# Attribute for field au_becs_debit
|
972
863
|
attr_reader :au_becs_debit
|
973
|
-
|
974
864
|
# Attribute for field bacs_debit
|
975
865
|
attr_reader :bacs_debit
|
976
|
-
|
977
866
|
# Attribute for field bancontact
|
978
867
|
attr_reader :bancontact
|
979
|
-
|
980
868
|
# Attribute for field boleto
|
981
869
|
attr_reader :boleto
|
982
|
-
|
983
870
|
# Attribute for field card
|
984
871
|
attr_reader :card
|
985
|
-
|
986
872
|
# Attribute for field cashapp
|
987
873
|
attr_reader :cashapp
|
988
|
-
|
989
874
|
# Attribute for field customer_balance
|
990
875
|
attr_reader :customer_balance
|
991
|
-
|
992
876
|
# Attribute for field eps
|
993
877
|
attr_reader :eps
|
994
|
-
|
995
878
|
# Attribute for field fpx
|
996
879
|
attr_reader :fpx
|
997
|
-
|
998
880
|
# Attribute for field giropay
|
999
881
|
attr_reader :giropay
|
1000
|
-
|
1001
882
|
# Attribute for field grabpay
|
1002
883
|
attr_reader :grabpay
|
1003
|
-
|
1004
884
|
# Attribute for field ideal
|
1005
885
|
attr_reader :ideal
|
1006
|
-
|
1007
886
|
# Attribute for field kakao_pay
|
1008
887
|
attr_reader :kakao_pay
|
1009
|
-
|
1010
888
|
# Attribute for field klarna
|
1011
889
|
attr_reader :klarna
|
1012
|
-
|
1013
890
|
# Attribute for field konbini
|
1014
891
|
attr_reader :konbini
|
1015
|
-
|
1016
892
|
# Attribute for field kr_card
|
1017
893
|
attr_reader :kr_card
|
1018
|
-
|
1019
894
|
# Attribute for field link
|
1020
895
|
attr_reader :link
|
1021
|
-
|
1022
896
|
# Attribute for field mobilepay
|
1023
897
|
attr_reader :mobilepay
|
1024
|
-
|
1025
898
|
# Attribute for field multibanco
|
1026
899
|
attr_reader :multibanco
|
1027
|
-
|
1028
900
|
# Attribute for field naver_pay
|
1029
901
|
attr_reader :naver_pay
|
1030
|
-
|
1031
902
|
# Attribute for field oxxo
|
1032
903
|
attr_reader :oxxo
|
1033
|
-
|
1034
904
|
# Attribute for field p24
|
1035
905
|
attr_reader :p24
|
1036
|
-
|
1037
906
|
# Attribute for field payco
|
1038
907
|
attr_reader :payco
|
1039
|
-
|
1040
908
|
# Attribute for field paynow
|
1041
909
|
attr_reader :paynow
|
1042
|
-
|
1043
910
|
# Attribute for field paypal
|
1044
911
|
attr_reader :paypal
|
1045
|
-
|
1046
912
|
# Attribute for field payto
|
1047
913
|
attr_reader :payto
|
1048
|
-
|
1049
914
|
# Attribute for field pix
|
1050
915
|
attr_reader :pix
|
1051
|
-
|
1052
916
|
# Attribute for field revolut_pay
|
1053
917
|
attr_reader :revolut_pay
|
1054
|
-
|
1055
918
|
# Attribute for field samsung_pay
|
1056
919
|
attr_reader :samsung_pay
|
1057
|
-
|
1058
920
|
# Attribute for field sepa_debit
|
1059
921
|
attr_reader :sepa_debit
|
1060
|
-
|
1061
922
|
# Attribute for field sofort
|
1062
923
|
attr_reader :sofort
|
1063
|
-
|
1064
924
|
# Attribute for field swish
|
1065
925
|
attr_reader :swish
|
1066
|
-
|
1067
926
|
# Attribute for field us_bank_account
|
1068
927
|
attr_reader :us_bank_account
|
1069
928
|
end
|
@@ -1076,7 +935,6 @@ module Stripe
|
|
1076
935
|
#
|
1077
936
|
# 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.
|
1078
937
|
attr_reader :line_items
|
1079
|
-
|
1080
938
|
# Determines which entity is allowed to update the shipping details.
|
1081
939
|
#
|
1082
940
|
# 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.
|
@@ -1096,17 +954,15 @@ module Stripe
|
|
1096
954
|
class SavedPaymentMethodOptions < Stripe::StripeObject
|
1097
955
|
# 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.
|
1098
956
|
attr_reader :allow_redisplay_filters
|
1099
|
-
|
1100
957
|
# Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
|
1101
958
|
attr_reader :payment_method_remove
|
1102
|
-
|
1103
959
|
# Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
|
1104
960
|
attr_reader :payment_method_save
|
1105
961
|
end
|
1106
962
|
|
1107
963
|
class ShippingAddressCollection < Stripe::StripeObject
|
1108
964
|
# An array of two-letter ISO country codes representing which countries Checkout should provide as options for
|
1109
|
-
# shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW,
|
965
|
+
# shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`.
|
1110
966
|
attr_reader :allowed_countries
|
1111
967
|
end
|
1112
968
|
|
@@ -1114,30 +970,23 @@ module Stripe
|
|
1114
970
|
class Tax < Stripe::StripeObject
|
1115
971
|
# Amount of tax applied for this rate.
|
1116
972
|
attr_reader :amount
|
1117
|
-
|
1118
973
|
# 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.
|
1119
974
|
#
|
1120
975
|
# Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)
|
1121
976
|
attr_reader :rate
|
1122
|
-
|
1123
977
|
# 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.
|
1124
978
|
attr_reader :taxability_reason
|
1125
|
-
|
1126
979
|
# The amount on which tax is calculated, in cents (or local equivalent).
|
1127
980
|
attr_reader :taxable_amount
|
1128
981
|
end
|
1129
982
|
# Total shipping cost before any discounts or taxes are applied.
|
1130
983
|
attr_reader :amount_subtotal
|
1131
|
-
|
1132
984
|
# Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
|
1133
985
|
attr_reader :amount_tax
|
1134
|
-
|
1135
986
|
# Total shipping cost after discounts and taxes are applied.
|
1136
987
|
attr_reader :amount_total
|
1137
|
-
|
1138
988
|
# The ID of the ShippingRate for this order.
|
1139
989
|
attr_reader :shipping_rate
|
1140
|
-
|
1141
990
|
# The taxes applied to the shipping rate.
|
1142
991
|
attr_reader :taxes
|
1143
992
|
end
|
@@ -1146,34 +995,25 @@ module Stripe
|
|
1146
995
|
class Address < Stripe::StripeObject
|
1147
996
|
# City, district, suburb, town, or village.
|
1148
997
|
attr_reader :city
|
1149
|
-
|
1150
998
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
1151
999
|
attr_reader :country
|
1152
|
-
|
1153
1000
|
# Address line 1 (e.g., street, PO Box, or company name).
|
1154
1001
|
attr_reader :line1
|
1155
|
-
|
1156
1002
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
1157
1003
|
attr_reader :line2
|
1158
|
-
|
1159
1004
|
# ZIP or postal code.
|
1160
1005
|
attr_reader :postal_code
|
1161
|
-
|
1162
1006
|
# State, county, province, or region.
|
1163
1007
|
attr_reader :state
|
1164
1008
|
end
|
1165
1009
|
# Attribute for field address
|
1166
1010
|
attr_reader :address
|
1167
|
-
|
1168
1011
|
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
|
1169
1012
|
attr_reader :carrier
|
1170
|
-
|
1171
1013
|
# Recipient name.
|
1172
1014
|
attr_reader :name
|
1173
|
-
|
1174
1015
|
# Recipient phone (including extension).
|
1175
1016
|
attr_reader :phone
|
1176
|
-
|
1177
1017
|
# 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.
|
1178
1018
|
attr_reader :tracking_number
|
1179
1019
|
end
|
@@ -1181,7 +1021,6 @@ module Stripe
|
|
1181
1021
|
class ShippingOption < Stripe::StripeObject
|
1182
1022
|
# A non-negative integer in cents representing how much to charge.
|
1183
1023
|
attr_reader :shipping_amount
|
1184
|
-
|
1185
1024
|
# The shipping rate.
|
1186
1025
|
attr_reader :shipping_rate
|
1187
1026
|
end
|
@@ -1189,7 +1028,6 @@ module Stripe
|
|
1189
1028
|
class TaxIdCollection < Stripe::StripeObject
|
1190
1029
|
# Indicates whether tax ID collection is enabled for the session
|
1191
1030
|
attr_reader :enabled
|
1192
|
-
|
1193
1031
|
# Indicates whether a tax ID is required on the payment page
|
1194
1032
|
attr_reader :required
|
1195
1033
|
end
|
@@ -1199,7 +1037,6 @@ module Stripe
|
|
1199
1037
|
class Discount < Stripe::StripeObject
|
1200
1038
|
# The amount discounted.
|
1201
1039
|
attr_reader :amount
|
1202
|
-
|
1203
1040
|
# 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).
|
1204
1041
|
# It contains information about when the discount began, when it will end, and what it is applied to.
|
1205
1042
|
#
|
@@ -1210,33 +1047,26 @@ module Stripe
|
|
1210
1047
|
class Tax < Stripe::StripeObject
|
1211
1048
|
# Amount of tax applied for this rate.
|
1212
1049
|
attr_reader :amount
|
1213
|
-
|
1214
1050
|
# 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.
|
1215
1051
|
#
|
1216
1052
|
# Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)
|
1217
1053
|
attr_reader :rate
|
1218
|
-
|
1219
1054
|
# 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.
|
1220
1055
|
attr_reader :taxability_reason
|
1221
|
-
|
1222
1056
|
# The amount on which tax is calculated, in cents (or local equivalent).
|
1223
1057
|
attr_reader :taxable_amount
|
1224
1058
|
end
|
1225
1059
|
# The aggregated discounts.
|
1226
1060
|
attr_reader :discounts
|
1227
|
-
|
1228
1061
|
# The aggregated tax amounts by rate.
|
1229
1062
|
attr_reader :taxes
|
1230
1063
|
end
|
1231
1064
|
# This is the sum of all the discounts.
|
1232
1065
|
attr_reader :amount_discount
|
1233
|
-
|
1234
1066
|
# This is the sum of all the shipping amounts.
|
1235
1067
|
attr_reader :amount_shipping
|
1236
|
-
|
1237
1068
|
# This is the sum of all the tax amounts.
|
1238
1069
|
attr_reader :amount_tax
|
1239
|
-
|
1240
1070
|
# Attribute for field breakdown
|
1241
1071
|
attr_reader :breakdown
|
1242
1072
|
end
|
@@ -1245,13 +1075,10 @@ module Stripe
|
|
1245
1075
|
class Created < Stripe::RequestParams
|
1246
1076
|
# Minimum value to filter by (exclusive)
|
1247
1077
|
attr_accessor :gt
|
1248
|
-
|
1249
1078
|
# Minimum value to filter by (inclusive)
|
1250
1079
|
attr_accessor :gte
|
1251
|
-
|
1252
1080
|
# Maximum value to filter by (exclusive)
|
1253
1081
|
attr_accessor :lt
|
1254
|
-
|
1255
1082
|
# Maximum value to filter by (inclusive)
|
1256
1083
|
attr_accessor :lte
|
1257
1084
|
|
@@ -1273,34 +1100,24 @@ module Stripe
|
|
1273
1100
|
end
|
1274
1101
|
# Only return Checkout Sessions that were created during the given date interval.
|
1275
1102
|
attr_accessor :created
|
1276
|
-
|
1277
1103
|
# Only return the Checkout Sessions for the Customer specified.
|
1278
1104
|
attr_accessor :customer
|
1279
|
-
|
1280
1105
|
# Only return the Checkout Sessions for the Customer details specified.
|
1281
1106
|
attr_accessor :customer_details
|
1282
|
-
|
1283
1107
|
# 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.
|
1284
1108
|
attr_accessor :ending_before
|
1285
|
-
|
1286
1109
|
# Specifies which fields in the response should be expanded.
|
1287
1110
|
attr_accessor :expand
|
1288
|
-
|
1289
1111
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
1290
1112
|
attr_accessor :limit
|
1291
|
-
|
1292
1113
|
# Only return the Checkout Session for the PaymentIntent specified.
|
1293
1114
|
attr_accessor :payment_intent
|
1294
|
-
|
1295
1115
|
# Only return the Checkout Sessions for the Payment Link specified.
|
1296
1116
|
attr_accessor :payment_link
|
1297
|
-
|
1298
1117
|
# 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.
|
1299
1118
|
attr_accessor :starting_after
|
1300
|
-
|
1301
1119
|
# Only return the Checkout Sessions matching the given status.
|
1302
1120
|
attr_accessor :status
|
1303
|
-
|
1304
1121
|
# Only return the Checkout Session for the subscription specified.
|
1305
1122
|
attr_accessor :subscription
|
1306
1123
|
|
@@ -1345,7 +1162,6 @@ module Stripe
|
|
1345
1162
|
class Recovery < Stripe::RequestParams
|
1346
1163
|
# Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
|
1347
1164
|
attr_accessor :allow_promotion_codes
|
1348
|
-
|
1349
1165
|
# If `true`, a recovery URL will be generated to recover this Checkout Session if it
|
1350
1166
|
# expires before a successful transaction is completed. It will be attached to the
|
1351
1167
|
# Checkout Session object upon expiration.
|
@@ -1368,7 +1184,6 @@ module Stripe
|
|
1368
1184
|
class Liability < Stripe::RequestParams
|
1369
1185
|
# The connected account being referenced when `type` is `account`.
|
1370
1186
|
attr_accessor :account
|
1371
|
-
|
1372
1187
|
# Type of the account referenced in the request.
|
1373
1188
|
attr_accessor :type
|
1374
1189
|
|
@@ -1381,7 +1196,6 @@ module Stripe
|
|
1381
1196
|
#
|
1382
1197
|
# Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.
|
1383
1198
|
attr_accessor :enabled
|
1384
|
-
|
1385
1199
|
# 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.
|
1386
1200
|
attr_accessor :liability
|
1387
1201
|
|
@@ -1403,12 +1217,10 @@ module Stripe
|
|
1403
1217
|
end
|
1404
1218
|
# Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.
|
1405
1219
|
attr_accessor :payment_method_reuse_agreement
|
1406
|
-
|
1407
1220
|
# If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
|
1408
1221
|
# Session will determine whether to display an option to opt into promotional communication
|
1409
1222
|
# from the merchant depending on the customer's locale. Only available to US merchants.
|
1410
1223
|
attr_accessor :promotions
|
1411
|
-
|
1412
1224
|
# If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
|
1413
1225
|
# There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
|
1414
1226
|
attr_accessor :terms_of_service
|
@@ -1429,7 +1241,6 @@ module Stripe
|
|
1429
1241
|
class Option < Stripe::RequestParams
|
1430
1242
|
# The label for the option, displayed to the customer. Up to 100 characters.
|
1431
1243
|
attr_accessor :label
|
1432
|
-
|
1433
1244
|
# 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.
|
1434
1245
|
attr_accessor :value
|
1435
1246
|
|
@@ -1440,7 +1251,6 @@ module Stripe
|
|
1440
1251
|
end
|
1441
1252
|
# The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
|
1442
1253
|
attr_accessor :default_value
|
1443
|
-
|
1444
1254
|
# The options available for the customer to select. Up to 200 options allowed.
|
1445
1255
|
attr_accessor :options
|
1446
1256
|
|
@@ -1453,7 +1263,6 @@ module Stripe
|
|
1453
1263
|
class Label < Stripe::RequestParams
|
1454
1264
|
# Custom text for the label, displayed to the customer. Up to 50 characters.
|
1455
1265
|
attr_accessor :custom
|
1456
|
-
|
1457
1266
|
# The type of the label.
|
1458
1267
|
attr_accessor :type
|
1459
1268
|
|
@@ -1466,10 +1275,8 @@ module Stripe
|
|
1466
1275
|
class Numeric < Stripe::RequestParams
|
1467
1276
|
# The value that will pre-fill the field on the payment page.
|
1468
1277
|
attr_accessor :default_value
|
1469
|
-
|
1470
1278
|
# The maximum character length constraint for the customer's input.
|
1471
1279
|
attr_accessor :maximum_length
|
1472
|
-
|
1473
1280
|
# The minimum character length requirement for the customer's input.
|
1474
1281
|
attr_accessor :minimum_length
|
1475
1282
|
|
@@ -1483,10 +1290,8 @@ module Stripe
|
|
1483
1290
|
class Text < Stripe::RequestParams
|
1484
1291
|
# The value that will pre-fill the field on the payment page.
|
1485
1292
|
attr_accessor :default_value
|
1486
|
-
|
1487
1293
|
# The maximum character length constraint for the customer's input.
|
1488
1294
|
attr_accessor :maximum_length
|
1489
|
-
|
1490
1295
|
# The minimum character length requirement for the customer's input.
|
1491
1296
|
attr_accessor :minimum_length
|
1492
1297
|
|
@@ -1498,22 +1303,16 @@ module Stripe
|
|
1498
1303
|
end
|
1499
1304
|
# Configuration for `type=dropdown` fields.
|
1500
1305
|
attr_accessor :dropdown
|
1501
|
-
|
1502
1306
|
# 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.
|
1503
1307
|
attr_accessor :key
|
1504
|
-
|
1505
1308
|
# The label for the field, displayed to the customer.
|
1506
1309
|
attr_accessor :label
|
1507
|
-
|
1508
1310
|
# Configuration for `type=numeric` fields.
|
1509
1311
|
attr_accessor :numeric
|
1510
|
-
|
1511
1312
|
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
|
1512
1313
|
attr_accessor :optional
|
1513
|
-
|
1514
1314
|
# Configuration for `type=text` fields.
|
1515
1315
|
attr_accessor :text
|
1516
|
-
|
1517
1316
|
# The type of the field.
|
1518
1317
|
attr_accessor :type
|
1519
1318
|
|
@@ -1574,13 +1373,10 @@ module Stripe
|
|
1574
1373
|
end
|
1575
1374
|
# Custom text that should be displayed after the payment confirmation button.
|
1576
1375
|
attr_accessor :after_submit
|
1577
|
-
|
1578
1376
|
# Custom text that should be displayed alongside shipping address collection.
|
1579
1377
|
attr_accessor :shipping_address
|
1580
|
-
|
1581
1378
|
# Custom text that should be displayed alongside the payment confirmation button.
|
1582
1379
|
attr_accessor :submit
|
1583
|
-
|
1584
1380
|
# Custom text that should be displayed in place of the default terms of service agreement text.
|
1585
1381
|
attr_accessor :terms_of_service_acceptance
|
1586
1382
|
|
@@ -1601,10 +1397,8 @@ module Stripe
|
|
1601
1397
|
# Describes whether Checkout saves the billing address onto `customer.address`.
|
1602
1398
|
# To always collect a full billing address, use `billing_address_collection`. Defaults to `never`.
|
1603
1399
|
attr_accessor :address
|
1604
|
-
|
1605
1400
|
# Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.
|
1606
1401
|
attr_accessor :name
|
1607
|
-
|
1608
1402
|
# Describes whether Checkout saves shipping information onto `customer.shipping`.
|
1609
1403
|
# To collect shipping information, use `shipping_address_collection`. Defaults to `never`.
|
1610
1404
|
attr_accessor :shipping
|
@@ -1619,7 +1413,6 @@ module Stripe
|
|
1619
1413
|
class Discount < Stripe::RequestParams
|
1620
1414
|
# The ID of the coupon to apply to this Session.
|
1621
1415
|
attr_accessor :coupon
|
1622
|
-
|
1623
1416
|
# The ID of a promotion code to apply to this Session.
|
1624
1417
|
attr_accessor :promotion_code
|
1625
1418
|
|
@@ -1634,7 +1427,6 @@ module Stripe
|
|
1634
1427
|
class CustomField < Stripe::RequestParams
|
1635
1428
|
# The name of the custom field. This may be up to 40 characters.
|
1636
1429
|
attr_accessor :name
|
1637
|
-
|
1638
1430
|
# The value of the custom field. This may be up to 140 characters.
|
1639
1431
|
attr_accessor :value
|
1640
1432
|
|
@@ -1647,7 +1439,6 @@ module Stripe
|
|
1647
1439
|
class Issuer < Stripe::RequestParams
|
1648
1440
|
# The connected account being referenced when `type` is `account`.
|
1649
1441
|
attr_accessor :account
|
1650
|
-
|
1651
1442
|
# Type of the account referenced in the request.
|
1652
1443
|
attr_accessor :type
|
1653
1444
|
|
@@ -1667,22 +1458,16 @@ module Stripe
|
|
1667
1458
|
end
|
1668
1459
|
# The account tax IDs associated with the invoice.
|
1669
1460
|
attr_accessor :account_tax_ids
|
1670
|
-
|
1671
1461
|
# Default custom fields to be displayed on invoices for this customer.
|
1672
1462
|
attr_accessor :custom_fields
|
1673
|
-
|
1674
1463
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
1675
1464
|
attr_accessor :description
|
1676
|
-
|
1677
1465
|
# Default footer to be displayed on invoices for this customer.
|
1678
1466
|
attr_accessor :footer
|
1679
|
-
|
1680
1467
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
1681
1468
|
attr_accessor :issuer
|
1682
|
-
|
1683
1469
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
1684
1470
|
attr_accessor :metadata
|
1685
|
-
|
1686
1471
|
# Default options for invoice PDF rendering for this customer.
|
1687
1472
|
attr_accessor :rendering_options
|
1688
1473
|
|
@@ -1706,7 +1491,6 @@ module Stripe
|
|
1706
1491
|
end
|
1707
1492
|
# Set to `true` to enable invoice creation.
|
1708
1493
|
attr_accessor :enabled
|
1709
|
-
|
1710
1494
|
# Parameters passed when creating invoices for payment-mode Checkout Sessions.
|
1711
1495
|
attr_accessor :invoice_data
|
1712
1496
|
|
@@ -1720,10 +1504,8 @@ module Stripe
|
|
1720
1504
|
class AdjustableQuantity < Stripe::RequestParams
|
1721
1505
|
# Set to true if the quantity can be adjusted to any non-negative integer.
|
1722
1506
|
attr_accessor :enabled
|
1723
|
-
|
1724
1507
|
# 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.
|
1725
1508
|
attr_accessor :maximum
|
1726
|
-
|
1727
1509
|
# The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
|
1728
1510
|
attr_accessor :minimum
|
1729
1511
|
|
@@ -1738,16 +1520,12 @@ module Stripe
|
|
1738
1520
|
class ProductData < Stripe::RequestParams
|
1739
1521
|
# 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.
|
1740
1522
|
attr_accessor :description
|
1741
|
-
|
1742
1523
|
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
1743
1524
|
attr_accessor :images
|
1744
|
-
|
1745
1525
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
1746
1526
|
attr_accessor :metadata
|
1747
|
-
|
1748
1527
|
# The product's name, meant to be displayable to the customer.
|
1749
1528
|
attr_accessor :name
|
1750
|
-
|
1751
1529
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
|
1752
1530
|
attr_accessor :tax_code
|
1753
1531
|
|
@@ -1763,7 +1541,6 @@ module Stripe
|
|
1763
1541
|
class Recurring < Stripe::RequestParams
|
1764
1542
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
1765
1543
|
attr_accessor :interval
|
1766
|
-
|
1767
1544
|
# 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).
|
1768
1545
|
attr_accessor :interval_count
|
1769
1546
|
|
@@ -1774,22 +1551,16 @@ module Stripe
|
|
1774
1551
|
end
|
1775
1552
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
1776
1553
|
attr_accessor :currency
|
1777
|
-
|
1778
1554
|
# The ID of the product that this price will belong to. One of `product` or `product_data` is required.
|
1779
1555
|
attr_accessor :product
|
1780
|
-
|
1781
1556
|
# Data used to generate a new product object inline. One of `product` or `product_data` is required.
|
1782
1557
|
attr_accessor :product_data
|
1783
|
-
|
1784
1558
|
# The recurring components of a price such as `interval` and `interval_count`.
|
1785
1559
|
attr_accessor :recurring
|
1786
|
-
|
1787
1560
|
# 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.
|
1788
1561
|
attr_accessor :tax_behavior
|
1789
|
-
|
1790
1562
|
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
|
1791
1563
|
attr_accessor :unit_amount
|
1792
|
-
|
1793
1564
|
# 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.
|
1794
1565
|
attr_accessor :unit_amount_decimal
|
1795
1566
|
|
@@ -1813,22 +1584,16 @@ module Stripe
|
|
1813
1584
|
end
|
1814
1585
|
# When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
|
1815
1586
|
attr_accessor :adjustable_quantity
|
1816
|
-
|
1817
1587
|
# 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.
|
1818
1588
|
attr_accessor :dynamic_tax_rates
|
1819
|
-
|
1820
1589
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
1821
1590
|
attr_accessor :metadata
|
1822
|
-
|
1823
1591
|
# 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.
|
1824
1592
|
attr_accessor :price
|
1825
|
-
|
1826
1593
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
1827
1594
|
attr_accessor :price_data
|
1828
|
-
|
1829
1595
|
# The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
|
1830
1596
|
attr_accessor :quantity
|
1831
|
-
|
1832
1597
|
# The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
|
1833
1598
|
attr_accessor :tax_rates
|
1834
1599
|
|
@@ -1856,19 +1621,14 @@ module Stripe
|
|
1856
1621
|
class Address < Stripe::RequestParams
|
1857
1622
|
# City, district, suburb, town, or village.
|
1858
1623
|
attr_accessor :city
|
1859
|
-
|
1860
1624
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
1861
1625
|
attr_accessor :country
|
1862
|
-
|
1863
1626
|
# Address line 1 (e.g., street, PO Box, or company name).
|
1864
1627
|
attr_accessor :line1
|
1865
|
-
|
1866
1628
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
1867
1629
|
attr_accessor :line2
|
1868
|
-
|
1869
1630
|
# ZIP or postal code.
|
1870
1631
|
attr_accessor :postal_code
|
1871
|
-
|
1872
1632
|
# State, county, province, or region.
|
1873
1633
|
attr_accessor :state
|
1874
1634
|
|
@@ -1890,16 +1650,12 @@ module Stripe
|
|
1890
1650
|
end
|
1891
1651
|
# Shipping address.
|
1892
1652
|
attr_accessor :address
|
1893
|
-
|
1894
1653
|
# The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
|
1895
1654
|
attr_accessor :carrier
|
1896
|
-
|
1897
1655
|
# Recipient name.
|
1898
1656
|
attr_accessor :name
|
1899
|
-
|
1900
1657
|
# Recipient phone (including extension).
|
1901
1658
|
attr_accessor :phone
|
1902
|
-
|
1903
1659
|
# 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.
|
1904
1660
|
attr_accessor :tracking_number
|
1905
1661
|
|
@@ -1915,7 +1671,6 @@ module Stripe
|
|
1915
1671
|
class TransferData < Stripe::RequestParams
|
1916
1672
|
# The amount that will be transferred automatically when a charge succeeds.
|
1917
1673
|
attr_accessor :amount
|
1918
|
-
|
1919
1674
|
# If specified, successful charges will be attributed to the destination
|
1920
1675
|
# account for tax reporting, and the funds from charges will be transferred
|
1921
1676
|
# to the destination account. The ID of the resulting transfer will be
|
@@ -1929,24 +1684,18 @@ module Stripe
|
|
1929
1684
|
end
|
1930
1685
|
# 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).
|
1931
1686
|
attr_accessor :application_fee_amount
|
1932
|
-
|
1933
1687
|
# Controls when the funds will be captured from the customer's account.
|
1934
1688
|
attr_accessor :capture_method
|
1935
|
-
|
1936
1689
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
1937
1690
|
attr_accessor :description
|
1938
|
-
|
1939
1691
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
1940
1692
|
attr_accessor :metadata
|
1941
|
-
|
1942
1693
|
# The Stripe account ID for which these funds are intended. For details,
|
1943
1694
|
# see the PaymentIntents [use case for connected
|
1944
1695
|
# accounts](/docs/payments/connected-accounts).
|
1945
1696
|
attr_accessor :on_behalf_of
|
1946
|
-
|
1947
1697
|
# 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).
|
1948
1698
|
attr_accessor :receipt_email
|
1949
|
-
|
1950
1699
|
# Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment
|
1951
1700
|
# method collected by this Checkout Session.
|
1952
1701
|
#
|
@@ -1968,22 +1717,17 @@ module Stripe
|
|
1968
1717
|
# to dynamically optimize your payment flow and comply with regional
|
1969
1718
|
# legislation and network rules, such as SCA.
|
1970
1719
|
attr_accessor :setup_future_usage
|
1971
|
-
|
1972
1720
|
# Shipping information for this payment.
|
1973
1721
|
attr_accessor :shipping
|
1974
|
-
|
1975
1722
|
# 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).
|
1976
1723
|
#
|
1977
1724
|
# 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.
|
1978
1725
|
attr_accessor :statement_descriptor
|
1979
|
-
|
1980
1726
|
# 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.
|
1981
1727
|
attr_accessor :statement_descriptor_suffix
|
1982
|
-
|
1983
1728
|
# The parameters used to automatically create a Transfer when the payment succeeds.
|
1984
1729
|
# For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
|
1985
1730
|
attr_accessor :transfer_data
|
1986
|
-
|
1987
1731
|
# 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.
|
1988
1732
|
attr_accessor :transfer_group
|
1989
1733
|
|
@@ -2032,16 +1776,12 @@ module Stripe
|
|
2032
1776
|
# The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
|
2033
1777
|
# or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
|
2034
1778
|
attr_accessor :custom_mandate_url
|
2035
|
-
|
2036
1779
|
# List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.
|
2037
1780
|
attr_accessor :default_for
|
2038
|
-
|
2039
1781
|
# Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
|
2040
1782
|
attr_accessor :interval_description
|
2041
|
-
|
2042
1783
|
# Payment schedule for the mandate.
|
2043
1784
|
attr_accessor :payment_schedule
|
2044
|
-
|
2045
1785
|
# Transaction type of the mandate.
|
2046
1786
|
attr_accessor :transaction_type
|
2047
1787
|
|
@@ -2061,10 +1801,8 @@ module Stripe
|
|
2061
1801
|
end
|
2062
1802
|
# Three-letter [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.
|
2063
1803
|
attr_accessor :currency
|
2064
|
-
|
2065
1804
|
# Additional fields for Mandate creation
|
2066
1805
|
attr_accessor :mandate_options
|
2067
|
-
|
2068
1806
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2069
1807
|
#
|
2070
1808
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2073,7 +1811,6 @@ module Stripe
|
|
2073
1811
|
#
|
2074
1812
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2075
1813
|
attr_accessor :setup_future_usage
|
2076
|
-
|
2077
1814
|
# Verification method for the intent
|
2078
1815
|
attr_accessor :verification_method
|
2079
1816
|
|
@@ -2176,7 +1913,6 @@ module Stripe
|
|
2176
1913
|
end
|
2177
1914
|
# Additional fields for Mandate creation
|
2178
1915
|
attr_accessor :mandate_options
|
2179
|
-
|
2180
1916
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2181
1917
|
#
|
2182
1918
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2210,7 +1946,6 @@ module Stripe
|
|
2210
1946
|
class Boleto < Stripe::RequestParams
|
2211
1947
|
# 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.
|
2212
1948
|
attr_accessor :expires_after_days
|
2213
|
-
|
2214
1949
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2215
1950
|
#
|
2216
1951
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2238,25 +1973,18 @@ module Stripe
|
|
2238
1973
|
end
|
2239
1974
|
# Installment options for card payments
|
2240
1975
|
attr_accessor :installments
|
2241
|
-
|
2242
1976
|
# Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
|
2243
1977
|
attr_accessor :request_decremental_authorization
|
2244
|
-
|
2245
1978
|
# Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
|
2246
1979
|
attr_accessor :request_extended_authorization
|
2247
|
-
|
2248
1980
|
# Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
|
2249
1981
|
attr_accessor :request_incremental_authorization
|
2250
|
-
|
2251
1982
|
# Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.
|
2252
1983
|
attr_accessor :request_multicapture
|
2253
|
-
|
2254
1984
|
# Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
|
2255
1985
|
attr_accessor :request_overcapture
|
2256
|
-
|
2257
1986
|
# 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.
|
2258
1987
|
attr_accessor :request_three_d_secure
|
2259
|
-
|
2260
1988
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2261
1989
|
#
|
2262
1990
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2265,10 +1993,8 @@ module Stripe
|
|
2265
1993
|
#
|
2266
1994
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2267
1995
|
attr_accessor :setup_future_usage
|
2268
|
-
|
2269
1996
|
# 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.
|
2270
1997
|
attr_accessor :statement_descriptor_suffix_kana
|
2271
|
-
|
2272
1998
|
# 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.
|
2273
1999
|
attr_accessor :statement_descriptor_suffix_kanji
|
2274
2000
|
|
@@ -2324,12 +2050,10 @@ module Stripe
|
|
2324
2050
|
end
|
2325
2051
|
# Configuration for eu_bank_transfer funding type.
|
2326
2052
|
attr_accessor :eu_bank_transfer
|
2327
|
-
|
2328
2053
|
# List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
|
2329
2054
|
#
|
2330
2055
|
# Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
|
2331
2056
|
attr_accessor :requested_address_types
|
2332
|
-
|
2333
2057
|
# The list of bank transfer types that this PaymentIntent is allowed to use for funding.
|
2334
2058
|
attr_accessor :type
|
2335
2059
|
|
@@ -2341,10 +2065,8 @@ module Stripe
|
|
2341
2065
|
end
|
2342
2066
|
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
|
2343
2067
|
attr_accessor :bank_transfer
|
2344
|
-
|
2345
2068
|
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
|
2346
2069
|
attr_accessor :funding_type
|
2347
|
-
|
2348
2070
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2349
2071
|
#
|
2350
2072
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2439,7 +2161,6 @@ module Stripe
|
|
2439
2161
|
class KakaoPay < Stripe::RequestParams
|
2440
2162
|
# Controls when the funds will be captured from the customer's account.
|
2441
2163
|
attr_accessor :capture_method
|
2442
|
-
|
2443
2164
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2444
2165
|
#
|
2445
2166
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2473,7 +2194,6 @@ module Stripe
|
|
2473
2194
|
class Konbini < Stripe::RequestParams
|
2474
2195
|
# 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.
|
2475
2196
|
attr_accessor :expires_after_days
|
2476
|
-
|
2477
2197
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2478
2198
|
#
|
2479
2199
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2492,7 +2212,6 @@ module Stripe
|
|
2492
2212
|
class KrCard < Stripe::RequestParams
|
2493
2213
|
# Controls when the funds will be captured from the customer's account.
|
2494
2214
|
attr_accessor :capture_method
|
2495
|
-
|
2496
2215
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2497
2216
|
#
|
2498
2217
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2556,7 +2275,6 @@ module Stripe
|
|
2556
2275
|
class NaverPay < Stripe::RequestParams
|
2557
2276
|
# Controls when the funds will be captured from the customer's account.
|
2558
2277
|
attr_accessor :capture_method
|
2559
|
-
|
2560
2278
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2561
2279
|
#
|
2562
2280
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2575,7 +2293,6 @@ module Stripe
|
|
2575
2293
|
class Oxxo < Stripe::RequestParams
|
2576
2294
|
# 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.
|
2577
2295
|
attr_accessor :expires_after_days
|
2578
|
-
|
2579
2296
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2580
2297
|
#
|
2581
2298
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2600,7 +2317,6 @@ module Stripe
|
|
2600
2317
|
#
|
2601
2318
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
2602
2319
|
attr_accessor :setup_future_usage
|
2603
|
-
|
2604
2320
|
# Confirm that the payer has accepted the P24 terms and conditions.
|
2605
2321
|
attr_accessor :tos_shown_and_accepted
|
2606
2322
|
|
@@ -2610,6 +2326,9 @@ module Stripe
|
|
2610
2326
|
end
|
2611
2327
|
end
|
2612
2328
|
|
2329
|
+
class PayByBank < Stripe::RequestParams
|
2330
|
+
end
|
2331
|
+
|
2613
2332
|
class Payco < Stripe::RequestParams
|
2614
2333
|
# Controls when the funds will be captured from the customer's account.
|
2615
2334
|
attr_accessor :capture_method
|
@@ -2637,19 +2356,14 @@ module Stripe
|
|
2637
2356
|
class Paypal < Stripe::RequestParams
|
2638
2357
|
# Controls when the funds will be captured from the customer's account.
|
2639
2358
|
attr_accessor :capture_method
|
2640
|
-
|
2641
2359
|
# [Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
|
2642
2360
|
attr_accessor :preferred_locale
|
2643
|
-
|
2644
2361
|
# 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.
|
2645
2362
|
attr_accessor :reference
|
2646
|
-
|
2647
2363
|
# 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.
|
2648
2364
|
attr_accessor :reference_id
|
2649
|
-
|
2650
2365
|
# The risk correlation ID for an on-session payment using a saved PayPal payment method.
|
2651
2366
|
attr_accessor :risk_correlation_id
|
2652
|
-
|
2653
2367
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2654
2368
|
#
|
2655
2369
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2660,7 +2374,6 @@ module Stripe
|
|
2660
2374
|
#
|
2661
2375
|
# If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
|
2662
2376
|
attr_accessor :setup_future_usage
|
2663
|
-
|
2664
2377
|
# 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.
|
2665
2378
|
attr_accessor :subsellers
|
2666
2379
|
|
@@ -2687,22 +2400,16 @@ module Stripe
|
|
2687
2400
|
class MandateOptions < Stripe::RequestParams
|
2688
2401
|
# Amount that will be collected. It is required when `amount_type` is `fixed`.
|
2689
2402
|
attr_accessor :amount
|
2690
|
-
|
2691
2403
|
# 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.
|
2692
2404
|
attr_accessor :amount_type
|
2693
|
-
|
2694
2405
|
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
2695
2406
|
attr_accessor :end_date
|
2696
|
-
|
2697
2407
|
# The periodicity at which payments will be collected.
|
2698
2408
|
attr_accessor :payment_schedule
|
2699
|
-
|
2700
2409
|
# 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.
|
2701
2410
|
attr_accessor :payments_per_period
|
2702
|
-
|
2703
2411
|
# The purpose for which payments are made. Defaults to retail.
|
2704
2412
|
attr_accessor :purpose
|
2705
|
-
|
2706
2413
|
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
2707
2414
|
attr_accessor :start_date
|
2708
2415
|
|
@@ -2726,7 +2433,6 @@ module Stripe
|
|
2726
2433
|
end
|
2727
2434
|
# Additional fields for Mandate creation
|
2728
2435
|
attr_accessor :mandate_options
|
2729
|
-
|
2730
2436
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2731
2437
|
#
|
2732
2438
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2786,7 +2492,6 @@ module Stripe
|
|
2786
2492
|
end
|
2787
2493
|
# Additional fields for Mandate creation
|
2788
2494
|
attr_accessor :mandate_options
|
2789
|
-
|
2790
2495
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2791
2496
|
#
|
2792
2497
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2830,7 +2535,6 @@ module Stripe
|
|
2830
2535
|
class FinancialConnections < Stripe::RequestParams
|
2831
2536
|
# 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`.
|
2832
2537
|
attr_accessor :permissions
|
2833
|
-
|
2834
2538
|
# List of data features that you would like to retrieve upon account creation.
|
2835
2539
|
attr_accessor :prefetch
|
2836
2540
|
|
@@ -2841,7 +2545,6 @@ module Stripe
|
|
2841
2545
|
end
|
2842
2546
|
# Additional fields for Financial Connections Session creation
|
2843
2547
|
attr_accessor :financial_connections
|
2844
|
-
|
2845
2548
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2846
2549
|
#
|
2847
2550
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2850,7 +2553,6 @@ module Stripe
|
|
2850
2553
|
#
|
2851
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).
|
2852
2555
|
attr_accessor :setup_future_usage
|
2853
|
-
|
2854
2556
|
# Verification method for the intent
|
2855
2557
|
attr_accessor :verification_method
|
2856
2558
|
|
@@ -2868,10 +2570,8 @@ module Stripe
|
|
2868
2570
|
class WechatPay < Stripe::RequestParams
|
2869
2571
|
# The app ID registered with WeChat Pay. Only required when client is ios or android.
|
2870
2572
|
attr_accessor :app_id
|
2871
|
-
|
2872
2573
|
# The client type that the end customer will pay from
|
2873
2574
|
attr_accessor :client
|
2874
|
-
|
2875
2575
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
2876
2576
|
#
|
2877
2577
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -2889,118 +2589,82 @@ module Stripe
|
|
2889
2589
|
end
|
2890
2590
|
# contains details about the ACSS Debit payment method options.
|
2891
2591
|
attr_accessor :acss_debit
|
2892
|
-
|
2893
2592
|
# contains details about the Affirm payment method options.
|
2894
2593
|
attr_accessor :affirm
|
2895
|
-
|
2896
2594
|
# contains details about the Afterpay Clearpay payment method options.
|
2897
2595
|
attr_accessor :afterpay_clearpay
|
2898
|
-
|
2899
2596
|
# contains details about the Alipay payment method options.
|
2900
2597
|
attr_accessor :alipay
|
2901
|
-
|
2902
2598
|
# contains details about the AmazonPay payment method options.
|
2903
2599
|
attr_accessor :amazon_pay
|
2904
|
-
|
2905
2600
|
# contains details about the AU Becs Debit payment method options.
|
2906
2601
|
attr_accessor :au_becs_debit
|
2907
|
-
|
2908
2602
|
# contains details about the Bacs Debit payment method options.
|
2909
2603
|
attr_accessor :bacs_debit
|
2910
|
-
|
2911
2604
|
# contains details about the Bancontact payment method options.
|
2912
2605
|
attr_accessor :bancontact
|
2913
|
-
|
2914
2606
|
# contains details about the Boleto payment method options.
|
2915
2607
|
attr_accessor :boleto
|
2916
|
-
|
2917
2608
|
# contains details about the Card payment method options.
|
2918
2609
|
attr_accessor :card
|
2919
|
-
|
2920
2610
|
# contains details about the Cashapp Pay payment method options.
|
2921
2611
|
attr_accessor :cashapp
|
2922
|
-
|
2923
2612
|
# contains details about the Customer Balance payment method options.
|
2924
2613
|
attr_accessor :customer_balance
|
2925
|
-
|
2926
2614
|
# contains details about the EPS payment method options.
|
2927
2615
|
attr_accessor :eps
|
2928
|
-
|
2929
2616
|
# contains details about the FPX payment method options.
|
2930
2617
|
attr_accessor :fpx
|
2931
|
-
|
2932
2618
|
# contains details about the Giropay payment method options.
|
2933
2619
|
attr_accessor :giropay
|
2934
|
-
|
2935
2620
|
# contains details about the Grabpay payment method options.
|
2936
2621
|
attr_accessor :grabpay
|
2937
|
-
|
2938
2622
|
# contains details about the Ideal payment method options.
|
2939
2623
|
attr_accessor :ideal
|
2940
|
-
|
2941
2624
|
# contains details about the Kakao Pay payment method options.
|
2942
2625
|
attr_accessor :kakao_pay
|
2943
|
-
|
2944
2626
|
# contains details about the Klarna payment method options.
|
2945
2627
|
attr_accessor :klarna
|
2946
|
-
|
2947
2628
|
# contains details about the Konbini payment method options.
|
2948
2629
|
attr_accessor :konbini
|
2949
|
-
|
2950
2630
|
# contains details about the Korean card payment method options.
|
2951
2631
|
attr_accessor :kr_card
|
2952
|
-
|
2953
2632
|
# contains details about the Link payment method options.
|
2954
2633
|
attr_accessor :link
|
2955
|
-
|
2956
2634
|
# contains details about the Mobilepay payment method options.
|
2957
2635
|
attr_accessor :mobilepay
|
2958
|
-
|
2959
2636
|
# contains details about the Multibanco payment method options.
|
2960
2637
|
attr_accessor :multibanco
|
2961
|
-
|
2962
2638
|
# contains details about the Naver Pay payment method options.
|
2963
2639
|
attr_accessor :naver_pay
|
2964
|
-
|
2965
2640
|
# contains details about the OXXO payment method options.
|
2966
2641
|
attr_accessor :oxxo
|
2967
|
-
|
2968
2642
|
# contains details about the P24 payment method options.
|
2969
2643
|
attr_accessor :p24
|
2970
|
-
|
2644
|
+
# contains details about the Pay By Bank payment method options.
|
2645
|
+
attr_accessor :pay_by_bank
|
2971
2646
|
# contains details about the PAYCO payment method options.
|
2972
2647
|
attr_accessor :payco
|
2973
|
-
|
2974
2648
|
# contains details about the PayNow payment method options.
|
2975
2649
|
attr_accessor :paynow
|
2976
|
-
|
2977
2650
|
# contains details about the PayPal payment method options.
|
2978
2651
|
attr_accessor :paypal
|
2979
|
-
|
2980
2652
|
# contains details about the PayTo payment method options.
|
2981
2653
|
attr_accessor :payto
|
2982
|
-
|
2983
2654
|
# contains details about the Pix payment method options.
|
2984
2655
|
attr_accessor :pix
|
2985
|
-
|
2986
2656
|
# contains details about the RevolutPay payment method options.
|
2987
2657
|
attr_accessor :revolut_pay
|
2988
|
-
|
2989
2658
|
# contains details about the Samsung Pay payment method options.
|
2990
2659
|
attr_accessor :samsung_pay
|
2991
|
-
|
2992
2660
|
# contains details about the Sepa Debit payment method options.
|
2993
2661
|
attr_accessor :sepa_debit
|
2994
|
-
|
2995
2662
|
# contains details about the Sofort payment method options.
|
2996
2663
|
attr_accessor :sofort
|
2997
|
-
|
2998
2664
|
# contains details about the Swish payment method options.
|
2999
2665
|
attr_accessor :swish
|
3000
|
-
|
3001
2666
|
# contains details about the Us Bank Account payment method options.
|
3002
2667
|
attr_accessor :us_bank_account
|
3003
|
-
|
3004
2668
|
# contains details about the WeChat Pay payment method options.
|
3005
2669
|
attr_accessor :wechat_pay
|
3006
2670
|
|
@@ -3032,6 +2696,7 @@ module Stripe
|
|
3032
2696
|
naver_pay: nil,
|
3033
2697
|
oxxo: nil,
|
3034
2698
|
p24: nil,
|
2699
|
+
pay_by_bank: nil,
|
3035
2700
|
payco: nil,
|
3036
2701
|
paynow: nil,
|
3037
2702
|
paypal: nil,
|
@@ -3072,6 +2737,7 @@ module Stripe
|
|
3072
2737
|
@naver_pay = naver_pay
|
3073
2738
|
@oxxo = oxxo
|
3074
2739
|
@p24 = p24
|
2740
|
+
@pay_by_bank = pay_by_bank
|
3075
2741
|
@payco = payco
|
3076
2742
|
@paynow = paynow
|
3077
2743
|
@paypal = paypal
|
@@ -3095,7 +2761,6 @@ module Stripe
|
|
3095
2761
|
#
|
3096
2762
|
# 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.
|
3097
2763
|
attr_accessor :line_items
|
3098
|
-
|
3099
2764
|
# Determines which entity is allowed to update the shipping details.
|
3100
2765
|
#
|
3101
2766
|
# 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.
|
@@ -3118,6 +2783,8 @@ module Stripe
|
|
3118
2783
|
|
3119
2784
|
class PhoneNumberCollection < Stripe::RequestParams
|
3120
2785
|
# Set to `true` to enable phone number collection.
|
2786
|
+
#
|
2787
|
+
# Can only be set in `payment` and `subscription` mode.
|
3121
2788
|
attr_accessor :enabled
|
3122
2789
|
|
3123
2790
|
def initialize(enabled: nil)
|
@@ -3128,7 +2795,6 @@ module Stripe
|
|
3128
2795
|
class SavedPaymentMethodOptions < Stripe::RequestParams
|
3129
2796
|
# 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.
|
3130
2797
|
attr_accessor :allow_redisplay_filters
|
3131
|
-
|
3132
2798
|
# Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
|
3133
2799
|
attr_accessor :payment_method_save
|
3134
2800
|
|
@@ -3141,10 +2807,8 @@ module Stripe
|
|
3141
2807
|
class SetupIntentData < Stripe::RequestParams
|
3142
2808
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
3143
2809
|
attr_accessor :description
|
3144
|
-
|
3145
2810
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
3146
2811
|
attr_accessor :metadata
|
3147
|
-
|
3148
2812
|
# The Stripe account for which the setup is intended.
|
3149
2813
|
attr_accessor :on_behalf_of
|
3150
2814
|
|
@@ -3171,7 +2835,6 @@ module Stripe
|
|
3171
2835
|
class Maximum < Stripe::RequestParams
|
3172
2836
|
# A unit of time.
|
3173
2837
|
attr_accessor :unit
|
3174
|
-
|
3175
2838
|
# Must be greater than 0.
|
3176
2839
|
attr_accessor :value
|
3177
2840
|
|
@@ -3184,7 +2847,6 @@ module Stripe
|
|
3184
2847
|
class Minimum < Stripe::RequestParams
|
3185
2848
|
# A unit of time.
|
3186
2849
|
attr_accessor :unit
|
3187
|
-
|
3188
2850
|
# Must be greater than 0.
|
3189
2851
|
attr_accessor :value
|
3190
2852
|
|
@@ -3195,7 +2857,6 @@ module Stripe
|
|
3195
2857
|
end
|
3196
2858
|
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
|
3197
2859
|
attr_accessor :maximum
|
3198
|
-
|
3199
2860
|
# The lower bound of the estimated range. If empty, represents no lower bound.
|
3200
2861
|
attr_accessor :minimum
|
3201
2862
|
|
@@ -3209,7 +2870,6 @@ module Stripe
|
|
3209
2870
|
class CurrencyOptions < Stripe::RequestParams
|
3210
2871
|
# A non-negative integer in cents representing how much to charge.
|
3211
2872
|
attr_accessor :amount
|
3212
|
-
|
3213
2873
|
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
3214
2874
|
attr_accessor :tax_behavior
|
3215
2875
|
|
@@ -3220,10 +2880,8 @@ module Stripe
|
|
3220
2880
|
end
|
3221
2881
|
# A non-negative integer in cents representing how much to charge.
|
3222
2882
|
attr_accessor :amount
|
3223
|
-
|
3224
2883
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
3225
2884
|
attr_accessor :currency
|
3226
|
-
|
3227
2885
|
# 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).
|
3228
2886
|
attr_accessor :currency_options
|
3229
2887
|
|
@@ -3235,22 +2893,16 @@ module Stripe
|
|
3235
2893
|
end
|
3236
2894
|
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
|
3237
2895
|
attr_accessor :delivery_estimate
|
3238
|
-
|
3239
2896
|
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
|
3240
2897
|
attr_accessor :display_name
|
3241
|
-
|
3242
2898
|
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
|
3243
2899
|
attr_accessor :fixed_amount
|
3244
|
-
|
3245
2900
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
3246
2901
|
attr_accessor :metadata
|
3247
|
-
|
3248
2902
|
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
3249
2903
|
attr_accessor :tax_behavior
|
3250
|
-
|
3251
2904
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
|
3252
2905
|
attr_accessor :tax_code
|
3253
|
-
|
3254
2906
|
# The type of calculation to use on the shipping rate.
|
3255
2907
|
attr_accessor :type
|
3256
2908
|
|
@@ -3274,7 +2926,6 @@ module Stripe
|
|
3274
2926
|
end
|
3275
2927
|
# The ID of the Shipping Rate to use for this shipping option.
|
3276
2928
|
attr_accessor :shipping_rate
|
3277
|
-
|
3278
2929
|
# Parameters to be passed to Shipping Rate creation for this shipping option.
|
3279
2930
|
attr_accessor :shipping_rate_data
|
3280
2931
|
|
@@ -3289,7 +2940,6 @@ module Stripe
|
|
3289
2940
|
class Issuer < Stripe::RequestParams
|
3290
2941
|
# The connected account being referenced when `type` is `account`.
|
3291
2942
|
attr_accessor :account
|
3292
|
-
|
3293
2943
|
# Type of the account referenced in the request.
|
3294
2944
|
attr_accessor :type
|
3295
2945
|
|
@@ -3309,7 +2959,6 @@ module Stripe
|
|
3309
2959
|
class TransferData < Stripe::RequestParams
|
3310
2960
|
# 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.
|
3311
2961
|
attr_accessor :amount_percent
|
3312
|
-
|
3313
2962
|
# ID of an existing, connected Stripe account.
|
3314
2963
|
attr_accessor :destination
|
3315
2964
|
|
@@ -3337,44 +2986,33 @@ module Stripe
|
|
3337
2986
|
end
|
3338
2987
|
# 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).
|
3339
2988
|
attr_accessor :application_fee_percent
|
3340
|
-
|
3341
2989
|
# A future timestamp to anchor the subscription's billing cycle for new subscriptions.
|
3342
2990
|
attr_accessor :billing_cycle_anchor
|
3343
|
-
|
3344
2991
|
# The tax rates that will apply to any subscription item that does not have
|
3345
2992
|
# `tax_rates` set. Invoices created will have their `default_tax_rates` populated
|
3346
2993
|
# from the subscription.
|
3347
2994
|
attr_accessor :default_tax_rates
|
3348
|
-
|
3349
2995
|
# The subscription's description, meant to be displayable to the customer.
|
3350
2996
|
# Use this field to optionally store an explanation of the subscription
|
3351
2997
|
# for rendering in the [customer portal](https://stripe.com/docs/customer-management).
|
3352
2998
|
attr_accessor :description
|
3353
|
-
|
3354
2999
|
# All invoices will be billed using the specified settings.
|
3355
3000
|
attr_accessor :invoice_settings
|
3356
|
-
|
3357
3001
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
3358
3002
|
attr_accessor :metadata
|
3359
|
-
|
3360
3003
|
# The account on behalf of which to charge, for each of the subscription's invoices.
|
3361
3004
|
attr_accessor :on_behalf_of
|
3362
|
-
|
3363
3005
|
# Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
|
3364
3006
|
attr_accessor :proration_behavior
|
3365
|
-
|
3366
3007
|
# 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.
|
3367
3008
|
attr_accessor :transfer_data
|
3368
|
-
|
3369
3009
|
# Unix timestamp representing the end of the trial period the customer
|
3370
3010
|
# will get before being charged for the first time. Has to be at least
|
3371
3011
|
# 48 hours in the future.
|
3372
3012
|
attr_accessor :trial_end
|
3373
|
-
|
3374
3013
|
# Integer representing the number of trial period days before the
|
3375
3014
|
# customer is charged for the first time. Has to be at least 1.
|
3376
3015
|
attr_accessor :trial_period_days
|
3377
|
-
|
3378
3016
|
# Settings related to subscription trials.
|
3379
3017
|
attr_accessor :trial_settings
|
3380
3018
|
|
@@ -3410,7 +3048,6 @@ module Stripe
|
|
3410
3048
|
class TaxIdCollection < Stripe::RequestParams
|
3411
3049
|
# Enable tax ID collection during checkout. Defaults to `false`.
|
3412
3050
|
attr_accessor :enabled
|
3413
|
-
|
3414
3051
|
# Describes whether a tax ID is required during checkout. Defaults to `never`.
|
3415
3052
|
attr_accessor :required
|
3416
3053
|
|
@@ -3421,39 +3058,28 @@ module Stripe
|
|
3421
3058
|
end
|
3422
3059
|
# Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
|
3423
3060
|
attr_accessor :adaptive_pricing
|
3424
|
-
|
3425
3061
|
# Configure actions after a Checkout Session has expired.
|
3426
3062
|
attr_accessor :after_expiration
|
3427
|
-
|
3428
3063
|
# Enables user redeemable promotion codes.
|
3429
3064
|
attr_accessor :allow_promotion_codes
|
3430
|
-
|
3431
3065
|
# Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
|
3432
3066
|
attr_accessor :automatic_tax
|
3433
|
-
|
3434
3067
|
# Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
|
3435
3068
|
attr_accessor :billing_address_collection
|
3436
|
-
|
3437
3069
|
# 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`.
|
3438
3070
|
attr_accessor :cancel_url
|
3439
|
-
|
3440
3071
|
# A unique string to reference the Checkout Session. This can be a
|
3441
3072
|
# customer ID, a cart ID, or similar, and can be used to reconcile the
|
3442
3073
|
# session with your internal systems.
|
3443
3074
|
attr_accessor :client_reference_id
|
3444
|
-
|
3445
3075
|
# Configure fields for the Checkout Session to gather active consent from customers.
|
3446
3076
|
attr_accessor :consent_collection
|
3447
|
-
|
3448
3077
|
# Three-letter [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.
|
3449
3078
|
attr_accessor :currency
|
3450
|
-
|
3451
3079
|
# Collect additional information from your customer using custom fields. Up to 3 fields are supported.
|
3452
3080
|
attr_accessor :custom_fields
|
3453
|
-
|
3454
3081
|
# Display additional text for your customers using custom text.
|
3455
3082
|
attr_accessor :custom_text
|
3456
|
-
|
3457
3083
|
# ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
|
3458
3084
|
# payment method will be used to prefill the email, name, card details, and billing address
|
3459
3085
|
# 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)
|
@@ -3466,7 +3092,6 @@ module Stripe
|
|
3466
3092
|
#
|
3467
3093
|
# 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.
|
3468
3094
|
attr_accessor :customer
|
3469
|
-
|
3470
3095
|
# Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
|
3471
3096
|
#
|
3472
3097
|
# When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
|
@@ -3477,48 +3102,36 @@ module Stripe
|
|
3477
3102
|
#
|
3478
3103
|
# Can only be set in `payment` and `setup` mode.
|
3479
3104
|
attr_accessor :customer_creation
|
3480
|
-
|
3481
3105
|
# If provided, this value will be used when the Customer object is created.
|
3482
3106
|
# If not provided, customers will be asked to enter their email address.
|
3483
3107
|
# Use this parameter to prefill customer data if you already have an email
|
3484
3108
|
# on file. To access information about the customer once a session is
|
3485
3109
|
# complete, use the `customer` field.
|
3486
3110
|
attr_accessor :customer_email
|
3487
|
-
|
3488
3111
|
# Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
|
3489
3112
|
attr_accessor :customer_update
|
3490
|
-
|
3491
3113
|
# The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
|
3492
3114
|
attr_accessor :discounts
|
3493
|
-
|
3494
3115
|
# Specifies which fields in the response should be expanded.
|
3495
3116
|
attr_accessor :expand
|
3496
|
-
|
3497
3117
|
# 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.
|
3498
3118
|
attr_accessor :expires_at
|
3499
|
-
|
3500
3119
|
# Generate a post-purchase Invoice for one-time payments.
|
3501
3120
|
attr_accessor :invoice_creation
|
3502
|
-
|
3503
3121
|
# A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
|
3504
3122
|
#
|
3505
3123
|
# 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.
|
3506
3124
|
#
|
3507
3125
|
# 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.
|
3508
3126
|
attr_accessor :line_items
|
3509
|
-
|
3510
3127
|
# The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
|
3511
3128
|
attr_accessor :locale
|
3512
|
-
|
3513
3129
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
3514
3130
|
attr_accessor :metadata
|
3515
|
-
|
3516
3131
|
# The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
|
3517
3132
|
attr_accessor :mode
|
3518
|
-
|
3519
3133
|
# A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
|
3520
3134
|
attr_accessor :payment_intent_data
|
3521
|
-
|
3522
3135
|
# 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.
|
3523
3136
|
# This may occur if the Checkout Session includes a free trial or a discount.
|
3524
3137
|
#
|
@@ -3526,16 +3139,12 @@ module Stripe
|
|
3526
3139
|
#
|
3527
3140
|
# 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).
|
3528
3141
|
attr_accessor :payment_method_collection
|
3529
|
-
|
3530
3142
|
# The ID of the payment method configuration to use with this Checkout session.
|
3531
3143
|
attr_accessor :payment_method_configuration
|
3532
|
-
|
3533
3144
|
# This parameter allows you to set some attributes on the payment method created during a Checkout session.
|
3534
3145
|
attr_accessor :payment_method_data
|
3535
|
-
|
3536
3146
|
# Payment-method-specific configuration.
|
3537
3147
|
attr_accessor :payment_method_options
|
3538
|
-
|
3539
3148
|
# A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
|
3540
3149
|
#
|
3541
3150
|
# You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
|
@@ -3548,56 +3157,43 @@ module Stripe
|
|
3548
3157
|
# prioritize the most relevant payment methods based on the customer's location and
|
3549
3158
|
# other characteristics.
|
3550
3159
|
attr_accessor :payment_method_types
|
3551
|
-
|
3552
3160
|
# This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
|
3553
3161
|
#
|
3554
3162
|
# For specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.
|
3555
3163
|
attr_accessor :permissions
|
3556
|
-
|
3557
3164
|
# Controls phone number collection settings for the session.
|
3558
3165
|
#
|
3559
3166
|
# We recommend that you review your privacy policy and check with your legal contacts
|
3560
3167
|
# before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).
|
3561
3168
|
attr_accessor :phone_number_collection
|
3562
|
-
|
3563
3169
|
# 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`.
|
3564
3170
|
attr_accessor :redirect_on_completion
|
3565
|
-
|
3566
3171
|
# The URL to redirect your customer back to after they authenticate or cancel their payment on the
|
3567
3172
|
# payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
|
3568
3173
|
# and redirect-based payment methods are enabled on the session.
|
3569
3174
|
attr_accessor :return_url
|
3570
|
-
|
3571
3175
|
# Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
|
3572
3176
|
attr_accessor :saved_payment_method_options
|
3573
|
-
|
3574
3177
|
# A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
|
3575
3178
|
attr_accessor :setup_intent_data
|
3576
|
-
|
3577
3179
|
# When set, provides configuration for Checkout to collect a shipping address from a customer.
|
3578
3180
|
attr_accessor :shipping_address_collection
|
3579
|
-
|
3580
3181
|
# The shipping rate options to apply to this Session. Up to a maximum of 5.
|
3581
3182
|
attr_accessor :shipping_options
|
3582
|
-
|
3583
3183
|
# Describes the type of transaction being performed by Checkout in order to customize
|
3584
3184
|
# relevant text on the page, such as the submit button. `submit_type` can only be
|
3585
3185
|
# specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
|
3586
3186
|
attr_accessor :submit_type
|
3587
|
-
|
3588
3187
|
# A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
|
3589
3188
|
attr_accessor :subscription_data
|
3590
|
-
|
3591
3189
|
# The URL to which Stripe should send customers when payment or setup
|
3592
3190
|
# is complete.
|
3593
3191
|
# This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
|
3594
3192
|
# information from the successful Checkout Session on your page, read the
|
3595
3193
|
# guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
|
3596
3194
|
attr_accessor :success_url
|
3597
|
-
|
3598
3195
|
# Controls tax ID collection during checkout.
|
3599
3196
|
attr_accessor :tax_id_collection
|
3600
|
-
|
3601
3197
|
# The UI mode of the Session. Defaults to `hosted`.
|
3602
3198
|
attr_accessor :ui_mode
|
3603
3199
|
|
@@ -3705,19 +3301,14 @@ module Stripe
|
|
3705
3301
|
class Address < Stripe::RequestParams
|
3706
3302
|
# City, district, suburb, town, or village.
|
3707
3303
|
attr_accessor :city
|
3708
|
-
|
3709
3304
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
3710
3305
|
attr_accessor :country
|
3711
|
-
|
3712
3306
|
# Address line 1 (e.g., street, PO Box, or company name).
|
3713
3307
|
attr_accessor :line1
|
3714
|
-
|
3715
3308
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
3716
3309
|
attr_accessor :line2
|
3717
|
-
|
3718
3310
|
# ZIP or postal code.
|
3719
3311
|
attr_accessor :postal_code
|
3720
|
-
|
3721
3312
|
# State, county, province, or region.
|
3722
3313
|
attr_accessor :state
|
3723
3314
|
|
@@ -3739,7 +3330,6 @@ module Stripe
|
|
3739
3330
|
end
|
3740
3331
|
# The address of the customer
|
3741
3332
|
attr_accessor :address
|
3742
|
-
|
3743
3333
|
# The name of customer
|
3744
3334
|
attr_accessor :name
|
3745
3335
|
|
@@ -3760,10 +3350,8 @@ module Stripe
|
|
3760
3350
|
class AdjustableQuantity < Stripe::RequestParams
|
3761
3351
|
# Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
|
3762
3352
|
attr_accessor :enabled
|
3763
|
-
|
3764
3353
|
# 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.
|
3765
3354
|
attr_accessor :maximum
|
3766
|
-
|
3767
3355
|
# The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
|
3768
3356
|
attr_accessor :minimum
|
3769
3357
|
|
@@ -3775,19 +3363,14 @@ module Stripe
|
|
3775
3363
|
end
|
3776
3364
|
# When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
|
3777
3365
|
attr_accessor :adjustable_quantity
|
3778
|
-
|
3779
3366
|
# ID of an existing line item.
|
3780
3367
|
attr_accessor :id
|
3781
|
-
|
3782
3368
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
3783
3369
|
attr_accessor :metadata
|
3784
|
-
|
3785
3370
|
# The ID of the [Price](https://stripe.com/docs/api/prices).
|
3786
3371
|
attr_accessor :price
|
3787
|
-
|
3788
3372
|
# The quantity of the line item being purchased.
|
3789
3373
|
attr_accessor :quantity
|
3790
|
-
|
3791
3374
|
# The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
|
3792
3375
|
attr_accessor :tax_rates
|
3793
3376
|
|
@@ -3814,7 +3397,6 @@ module Stripe
|
|
3814
3397
|
class Maximum < Stripe::RequestParams
|
3815
3398
|
# A unit of time.
|
3816
3399
|
attr_accessor :unit
|
3817
|
-
|
3818
3400
|
# Must be greater than 0.
|
3819
3401
|
attr_accessor :value
|
3820
3402
|
|
@@ -3827,7 +3409,6 @@ module Stripe
|
|
3827
3409
|
class Minimum < Stripe::RequestParams
|
3828
3410
|
# A unit of time.
|
3829
3411
|
attr_accessor :unit
|
3830
|
-
|
3831
3412
|
# Must be greater than 0.
|
3832
3413
|
attr_accessor :value
|
3833
3414
|
|
@@ -3838,7 +3419,6 @@ module Stripe
|
|
3838
3419
|
end
|
3839
3420
|
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
|
3840
3421
|
attr_accessor :maximum
|
3841
|
-
|
3842
3422
|
# The lower bound of the estimated range. If empty, represents no lower bound.
|
3843
3423
|
attr_accessor :minimum
|
3844
3424
|
|
@@ -3852,7 +3432,6 @@ module Stripe
|
|
3852
3432
|
class CurrencyOptions < Stripe::RequestParams
|
3853
3433
|
# A non-negative integer in cents representing how much to charge.
|
3854
3434
|
attr_accessor :amount
|
3855
|
-
|
3856
3435
|
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
3857
3436
|
attr_accessor :tax_behavior
|
3858
3437
|
|
@@ -3863,10 +3442,8 @@ module Stripe
|
|
3863
3442
|
end
|
3864
3443
|
# A non-negative integer in cents representing how much to charge.
|
3865
3444
|
attr_accessor :amount
|
3866
|
-
|
3867
3445
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
3868
3446
|
attr_accessor :currency
|
3869
|
-
|
3870
3447
|
# 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).
|
3871
3448
|
attr_accessor :currency_options
|
3872
3449
|
|
@@ -3878,22 +3455,16 @@ module Stripe
|
|
3878
3455
|
end
|
3879
3456
|
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
|
3880
3457
|
attr_accessor :delivery_estimate
|
3881
|
-
|
3882
3458
|
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
|
3883
3459
|
attr_accessor :display_name
|
3884
|
-
|
3885
3460
|
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
|
3886
3461
|
attr_accessor :fixed_amount
|
3887
|
-
|
3888
3462
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
3889
3463
|
attr_accessor :metadata
|
3890
|
-
|
3891
3464
|
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
3892
3465
|
attr_accessor :tax_behavior
|
3893
|
-
|
3894
3466
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
|
3895
3467
|
attr_accessor :tax_code
|
3896
|
-
|
3897
3468
|
# The type of calculation to use on the shipping rate.
|
3898
3469
|
attr_accessor :type
|
3899
3470
|
|
@@ -3917,7 +3488,6 @@ module Stripe
|
|
3917
3488
|
end
|
3918
3489
|
# The ID of the Shipping Rate to use for this shipping option.
|
3919
3490
|
attr_accessor :shipping_rate
|
3920
|
-
|
3921
3491
|
# Parameters to be passed to Shipping Rate creation for this shipping option.
|
3922
3492
|
attr_accessor :shipping_rate_data
|
3923
3493
|
|
@@ -3928,10 +3498,8 @@ module Stripe
|
|
3928
3498
|
end
|
3929
3499
|
# Information about the customer collected within the Checkout Session.
|
3930
3500
|
attr_accessor :collected_information
|
3931
|
-
|
3932
3501
|
# Specifies which fields in the response should be expanded.
|
3933
3502
|
attr_accessor :expand
|
3934
|
-
|
3935
3503
|
# A list of items the customer is purchasing.
|
3936
3504
|
#
|
3937
3505
|
# When updating line items, you must retransmit the entire array of line items.
|
@@ -3946,10 +3514,8 @@ module Stripe
|
|
3946
3514
|
#
|
3947
3515
|
# To reorder a line item, specify it at the desired position in the retransmitted array.
|
3948
3516
|
attr_accessor :line_items
|
3949
|
-
|
3950
3517
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
3951
3518
|
attr_accessor :metadata
|
3952
|
-
|
3953
3519
|
# The shipping rate options to apply to this Session. Up to a maximum of 5.
|
3954
3520
|
attr_accessor :shipping_options
|
3955
3521
|
|
@@ -3971,13 +3537,10 @@ module Stripe
|
|
3971
3537
|
class ListLineItemsParams < Stripe::RequestParams
|
3972
3538
|
# 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.
|
3973
3539
|
attr_accessor :ending_before
|
3974
|
-
|
3975
3540
|
# Specifies which fields in the response should be expanded.
|
3976
3541
|
attr_accessor :expand
|
3977
|
-
|
3978
3542
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
3979
3543
|
attr_accessor :limit
|
3980
|
-
|
3981
3544
|
# 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.
|
3982
3545
|
attr_accessor :starting_after
|
3983
3546
|
|
@@ -3999,192 +3562,137 @@ module Stripe
|
|
3999
3562
|
end
|
4000
3563
|
# Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
|
4001
3564
|
attr_reader :adaptive_pricing
|
4002
|
-
|
4003
3565
|
# When set, provides configuration for actions to take if this Checkout Session expires.
|
4004
3566
|
attr_reader :after_expiration
|
4005
|
-
|
4006
3567
|
# Enables user redeemable promotion codes.
|
4007
3568
|
attr_reader :allow_promotion_codes
|
4008
|
-
|
4009
3569
|
# Total of all items before discounts or taxes are applied.
|
4010
3570
|
attr_reader :amount_subtotal
|
4011
|
-
|
4012
3571
|
# Total of all items after discounts and taxes are applied.
|
4013
3572
|
attr_reader :amount_total
|
4014
|
-
|
4015
3573
|
# Attribute for field automatic_tax
|
4016
3574
|
attr_reader :automatic_tax
|
4017
|
-
|
4018
3575
|
# Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.
|
4019
3576
|
attr_reader :billing_address_collection
|
4020
|
-
|
4021
3577
|
# 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.
|
4022
3578
|
attr_reader :cancel_url
|
4023
|
-
|
4024
3579
|
# A unique string to reference the Checkout Session. This can be a
|
4025
3580
|
# customer ID, a cart ID, or similar, and can be used to reconcile the
|
4026
3581
|
# Session with your internal systems.
|
4027
3582
|
attr_reader :client_reference_id
|
4028
|
-
|
4029
3583
|
# The client secret of the Session. Use this with [initCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.
|
4030
3584
|
attr_reader :client_secret
|
4031
|
-
|
4032
3585
|
# Information about the customer collected within the Checkout Session.
|
4033
3586
|
attr_reader :collected_information
|
4034
|
-
|
4035
3587
|
# Results of `consent_collection` for this session.
|
4036
3588
|
attr_reader :consent
|
4037
|
-
|
4038
3589
|
# When set, provides configuration for the Checkout Session to gather active consent from customers.
|
4039
3590
|
attr_reader :consent_collection
|
4040
|
-
|
4041
3591
|
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
4042
3592
|
attr_reader :created
|
4043
|
-
|
4044
3593
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
4045
3594
|
attr_reader :currency
|
4046
|
-
|
4047
3595
|
# Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions
|
4048
3596
|
attr_reader :currency_conversion
|
4049
|
-
|
4050
3597
|
# Collect additional information from your customer using custom fields. Up to 3 fields are supported.
|
4051
3598
|
attr_reader :custom_fields
|
4052
|
-
|
4053
3599
|
# Attribute for field custom_text
|
4054
3600
|
attr_reader :custom_text
|
4055
|
-
|
4056
3601
|
# The ID of the customer for this Session.
|
4057
3602
|
# For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout
|
4058
3603
|
# will create a new customer object based on information provided
|
4059
3604
|
# during the payment flow unless an existing customer was provided when
|
4060
3605
|
# the Session was created.
|
4061
3606
|
attr_reader :customer
|
4062
|
-
|
4063
3607
|
# Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
|
4064
3608
|
attr_reader :customer_creation
|
4065
|
-
|
4066
3609
|
# 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.
|
4067
3610
|
attr_reader :customer_details
|
4068
|
-
|
4069
3611
|
# If provided, this value will be used when the Customer object is created.
|
4070
3612
|
# If not provided, customers will be asked to enter their email address.
|
4071
3613
|
# Use this parameter to prefill customer data if you already have an email
|
4072
3614
|
# on file. To access information about the customer once the payment flow is
|
4073
3615
|
# complete, use the `customer` attribute.
|
4074
3616
|
attr_reader :customer_email
|
4075
|
-
|
3617
|
+
# List of coupons and promotion codes attached to the Checkout Session.
|
3618
|
+
attr_reader :discounts
|
4076
3619
|
# The timestamp at which the Checkout Session will expire.
|
4077
3620
|
attr_reader :expires_at
|
4078
|
-
|
4079
3621
|
# Unique identifier for the object.
|
4080
3622
|
attr_reader :id
|
4081
|
-
|
4082
3623
|
# ID of the invoice created by the Checkout Session, if it exists.
|
4083
3624
|
attr_reader :invoice
|
4084
|
-
|
4085
3625
|
# Details on the state of invoice creation for the Checkout Session.
|
4086
3626
|
attr_reader :invoice_creation
|
4087
|
-
|
4088
3627
|
# The line items purchased by the customer.
|
4089
3628
|
attr_reader :line_items
|
4090
|
-
|
4091
3629
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
4092
3630
|
attr_reader :livemode
|
4093
|
-
|
4094
3631
|
# The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
|
4095
3632
|
attr_reader :locale
|
4096
|
-
|
4097
3633
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
4098
3634
|
attr_reader :metadata
|
4099
|
-
|
4100
3635
|
# The mode of the Checkout Session.
|
4101
3636
|
attr_reader :mode
|
4102
|
-
|
4103
3637
|
# String representing the object's type. Objects of the same type share the same value.
|
4104
3638
|
attr_reader :object
|
4105
|
-
|
4106
3639
|
# 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.
|
4107
3640
|
attr_reader :payment_intent
|
4108
|
-
|
4109
3641
|
# The ID of the Payment Link that created this Session.
|
4110
3642
|
attr_reader :payment_link
|
4111
|
-
|
4112
3643
|
# Configure whether a Checkout Session should collect a payment method. Defaults to `always`.
|
4113
3644
|
attr_reader :payment_method_collection
|
4114
|
-
|
4115
3645
|
# Information about the payment method configuration used for this Checkout session if using dynamic payment methods.
|
4116
3646
|
attr_reader :payment_method_configuration_details
|
4117
|
-
|
4118
3647
|
# Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
|
4119
3648
|
attr_reader :payment_method_options
|
4120
|
-
|
4121
3649
|
# A list of the types of payment methods (e.g. card) this Checkout
|
4122
3650
|
# Session is allowed to accept.
|
4123
3651
|
attr_reader :payment_method_types
|
4124
|
-
|
4125
3652
|
# The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.
|
4126
3653
|
# You can use this value to decide when to fulfill your customer's order.
|
4127
3654
|
attr_reader :payment_status
|
4128
|
-
|
4129
3655
|
# This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
|
4130
3656
|
#
|
4131
3657
|
# For specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.
|
4132
3658
|
attr_reader :permissions
|
4133
|
-
|
4134
3659
|
# Attribute for field phone_number_collection
|
4135
3660
|
attr_reader :phone_number_collection
|
4136
|
-
|
4137
3661
|
# The ID of the original expired Checkout Session that triggered the recovery flow.
|
4138
3662
|
attr_reader :recovered_from
|
4139
|
-
|
4140
3663
|
# 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`.
|
4141
3664
|
attr_reader :redirect_on_completion
|
4142
|
-
|
4143
3665
|
# 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.
|
4144
3666
|
attr_reader :return_url
|
4145
|
-
|
4146
3667
|
# Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
|
4147
3668
|
attr_reader :saved_payment_method_options
|
4148
|
-
|
4149
3669
|
# 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.
|
4150
3670
|
attr_reader :setup_intent
|
4151
|
-
|
4152
3671
|
# When set, provides configuration for Checkout to collect a shipping address from a customer.
|
4153
3672
|
attr_reader :shipping_address_collection
|
4154
|
-
|
4155
3673
|
# The details of the customer cost of shipping, including the customer chosen ShippingRate.
|
4156
3674
|
attr_reader :shipping_cost
|
4157
|
-
|
4158
3675
|
# Shipping information for this Checkout Session.
|
4159
3676
|
attr_reader :shipping_details
|
4160
|
-
|
4161
3677
|
# The shipping rate options applied to this Session.
|
4162
3678
|
attr_reader :shipping_options
|
4163
|
-
|
4164
3679
|
# The status of the Checkout Session, one of `open`, `complete`, or `expired`.
|
4165
3680
|
attr_reader :status
|
4166
|
-
|
4167
3681
|
# Describes the type of transaction being performed by Checkout in order to customize
|
4168
3682
|
# relevant text on the page, such as the submit button. `submit_type` can only be
|
4169
3683
|
# specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
|
4170
3684
|
attr_reader :submit_type
|
4171
|
-
|
4172
3685
|
# The ID of the subscription for Checkout Sessions in `subscription` mode.
|
4173
3686
|
attr_reader :subscription
|
4174
|
-
|
4175
3687
|
# The URL the customer will be directed to after the payment or
|
4176
3688
|
# subscription creation is successful.
|
4177
3689
|
attr_reader :success_url
|
4178
|
-
|
4179
3690
|
# Attribute for field tax_id_collection
|
4180
3691
|
attr_reader :tax_id_collection
|
4181
|
-
|
4182
3692
|
# Tax and discount details for the computed total amount.
|
4183
3693
|
attr_reader :total_details
|
4184
|
-
|
4185
3694
|
# The UI mode of the Session. Defaults to `hosted`.
|
4186
3695
|
attr_reader :ui_mode
|
4187
|
-
|
4188
3696
|
# 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.`
|
4189
3697
|
# This value is only present when the session is active.
|
4190
3698
|
attr_reader :url
|