stripe 18.1.0.pre.alpha.4 → 18.2.0.pre.alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/data/ca-certificates.crt +682 -518
- data/lib/stripe/api_requestor.rb +2 -0
- data/lib/stripe/api_version.rb +1 -1
- data/lib/stripe/errors.rb +3 -0
- data/lib/stripe/event_types.rb +56 -0
- data/lib/stripe/events/v2_core_health_api_error_firing_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_api_error_resolved_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_api_latency_firing_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_api_latency_resolved_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_payment_method_error_firing_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_payment_method_error_resolved_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_sepa_debit_delayed_firing_event.rb +58 -0
- data/lib/stripe/events/v2_core_health_sepa_debit_delayed_resolved_event.rb +60 -0
- data/lib/stripe/events/v2_money_management_payout_method_created_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_canceled_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_created_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_errored_event.rb +65 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_funds_not_received_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_matched_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_not_found_event.rb +38 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_settled_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_split_canceled_event.rb +61 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_split_created_event.rb +61 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_split_settled_event.rb +61 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_submitted_event.rb +44 -0
- data/lib/stripe/object_types.rb +6 -0
- data/lib/stripe/params/account_create_params.rb +50 -28
- data/lib/stripe/params/account_external_account_create_params.rb +2 -2
- data/lib/stripe/params/account_external_account_update_params.rb +2 -2
- data/lib/stripe/params/account_notice_update_params.rb +1 -1
- data/lib/stripe/params/account_person_create_params.rb +10 -10
- data/lib/stripe/params/account_person_update_params.rb +10 -10
- data/lib/stripe/params/account_session_create_params.rb +17 -0
- data/lib/stripe/params/account_update_params.rb +49 -27
- data/lib/stripe/params/application_fee_refund_create_params.rb +1 -1
- data/lib/stripe/params/application_fee_refund_update_params.rb +1 -1
- data/lib/stripe/params/balance_transfer_create_params.rb +1 -1
- data/lib/stripe/params/billing/credit_balance_summary_retrieve_params.rb +2 -2
- data/lib/stripe/params/billing/credit_balance_transaction_list_params.rb +2 -2
- data/lib/stripe/params/billing/credit_grant_create_params.rb +2 -2
- data/lib/stripe/params/billing/credit_grant_list_params.rb +1 -1
- data/lib/stripe/params/billing/meter_event_create_params.rb +1 -1
- data/lib/stripe/params/billing_portal/configuration_create_params.rb +7 -3
- data/lib/stripe/params/billing_portal/configuration_update_params.rb +7 -3
- data/lib/stripe/params/billing_portal/session_create_params.rb +7 -7
- data/lib/stripe/params/charge_capture_params.rb +9 -9
- data/lib/stripe/params/charge_create_params.rb +12 -12
- data/lib/stripe/params/charge_search_params.rb +1 -1
- data/lib/stripe/params/charge_update_params.rb +10 -10
- data/lib/stripe/params/checkout/session_create_params.rb +53 -41
- data/lib/stripe/params/checkout/session_update_params.rb +27 -15
- data/lib/stripe/params/climate/order_create_params.rb +1 -1
- data/lib/stripe/params/climate/order_update_params.rb +1 -1
- data/lib/stripe/params/confirmation_token_create_params.rb +6 -6
- data/lib/stripe/params/coupon_create_params.rb +1 -1
- data/lib/stripe/params/coupon_update_params.rb +1 -1
- data/lib/stripe/params/credit_note_create_params.rb +1 -1
- data/lib/stripe/params/credit_note_list_params.rb +1 -1
- data/lib/stripe/params/credit_note_list_preview_line_items_params.rb +1 -1
- data/lib/stripe/params/credit_note_preview_lines_list_params.rb +1 -1
- data/lib/stripe/params/credit_note_preview_params.rb +1 -1
- data/lib/stripe/params/credit_note_update_params.rb +1 -1
- data/lib/stripe/params/customer_balance_transaction_create_params.rb +2 -2
- data/lib/stripe/params/customer_balance_transaction_list_params.rb +11 -1
- data/lib/stripe/params/customer_balance_transaction_update_params.rb +1 -1
- data/lib/stripe/params/customer_cash_balance_update_params.rb +1 -1
- data/lib/stripe/params/customer_create_params.rb +5 -5
- data/lib/stripe/params/customer_fund_cash_balance_params.rb +2 -2
- data/lib/stripe/params/customer_payment_source_create_params.rb +2 -2
- data/lib/stripe/params/customer_payment_source_update_params.rb +2 -2
- data/lib/stripe/params/customer_search_params.rb +1 -1
- data/lib/stripe/params/customer_update_params.rb +7 -7
- data/lib/stripe/params/delegated_checkout/requested_session_confirm_params.rb +84 -1
- data/lib/stripe/params/dispute_update_params.rb +3 -3
- data/lib/stripe/params/external_account_create_params.rb +2 -2
- data/lib/stripe/params/external_account_update_params.rb +2 -2
- data/lib/stripe/params/file_create_params.rb +3 -3
- data/lib/stripe/params/file_link_create_params.rb +1 -1
- data/lib/stripe/params/file_link_update_params.rb +1 -1
- data/lib/stripe/params/financial_connections/account_list_params.rb +3 -3
- data/lib/stripe/params/financial_connections/session_create_params.rb +3 -3
- data/lib/stripe/params/forwarding/request_create_params.rb +1 -1
- data/lib/stripe/params/identity/verification_session_create_params.rb +6 -6
- data/lib/stripe/params/identity/verification_session_list_params.rb +3 -3
- data/lib/stripe/params/identity/verification_session_update_params.rb +5 -5
- data/lib/stripe/params/invoice_add_lines_params.rb +21 -9
- data/lib/stripe/params/invoice_attach_payment_params.rb +1 -1
- data/lib/stripe/params/invoice_create_params.rb +37 -13
- data/lib/stripe/params/invoice_create_preview_params.rb +60 -60
- data/lib/stripe/params/invoice_finalize_invoice_params.rb +1 -1
- data/lib/stripe/params/invoice_item_create_params.rb +8 -8
- data/lib/stripe/params/invoice_item_list_params.rb +2 -2
- data/lib/stripe/params/invoice_item_update_params.rb +6 -6
- data/lib/stripe/params/invoice_line_item_update_params.rb +20 -8
- data/lib/stripe/params/invoice_list_params.rb +2 -2
- data/lib/stripe/params/invoice_remove_lines_params.rb +1 -1
- data/lib/stripe/params/invoice_search_params.rb +1 -1
- data/lib/stripe/params/invoice_update_lines_params.rb +21 -9
- data/lib/stripe/params/invoice_update_params.rb +34 -10
- data/lib/stripe/params/issuing/authorization_approve_params.rb +2 -2
- data/lib/stripe/params/issuing/authorization_capture_params.rb +1 -1
- data/lib/stripe/params/issuing/authorization_create_params.rb +5 -5
- data/lib/stripe/params/issuing/authorization_decline_params.rb +1 -1
- data/lib/stripe/params/issuing/authorization_finalize_amount_params.rb +1 -1
- data/lib/stripe/params/issuing/authorization_increment_params.rb +2 -2
- data/lib/stripe/params/issuing/authorization_reverse_params.rb +1 -1
- data/lib/stripe/params/issuing/authorization_update_params.rb +1 -1
- data/lib/stripe/params/issuing/card_create_params.rb +7 -7
- data/lib/stripe/params/issuing/card_list_params.rb +34 -1
- data/lib/stripe/params/issuing/card_update_params.rb +6 -6
- data/lib/stripe/params/issuing/cardholder_create_params.rb +11 -11
- data/lib/stripe/params/issuing/cardholder_update_params.rb +10 -10
- data/lib/stripe/params/issuing/credit_underwriting_record_correct_params.rb +5 -5
- data/lib/stripe/params/issuing/credit_underwriting_record_create_from_application_params.rb +1 -1
- data/lib/stripe/params/issuing/credit_underwriting_record_create_from_proactive_review_params.rb +5 -5
- data/lib/stripe/params/issuing/credit_underwriting_record_report_decision_params.rb +4 -4
- data/lib/stripe/params/issuing/dispute_create_params.rb +2 -2
- data/lib/stripe/params/issuing/dispute_submit_params.rb +1 -1
- data/lib/stripe/params/issuing/dispute_update_params.rb +2 -2
- data/lib/stripe/params/issuing/personalization_design_create_params.rb +1 -1
- data/lib/stripe/params/issuing/personalization_design_update_params.rb +1 -1
- data/lib/stripe/params/issuing/program_update_params.rb +1 -1
- data/lib/stripe/params/issuing/transaction_create_force_capture_params.rb +2 -2
- data/lib/stripe/params/issuing/transaction_create_unlinked_refund_params.rb +2 -2
- data/lib/stripe/params/issuing/transaction_refund_params.rb +1 -1
- data/lib/stripe/params/issuing/transaction_update_params.rb +1 -1
- data/lib/stripe/params/mandate_list_params.rb +1 -1
- data/lib/stripe/params/margin_create_params.rb +1 -1
- data/lib/stripe/params/margin_update_params.rb +1 -1
- data/lib/stripe/params/order_create_params.rb +12 -12
- data/lib/stripe/params/order_update_params.rb +12 -12
- data/lib/stripe/params/payment_intent_apply_customer_balance_params.rb +1 -1
- data/lib/stripe/params/payment_intent_capture_params.rb +18 -18
- data/lib/stripe/params/payment_intent_confirm_params.rb +43 -39
- data/lib/stripe/params/payment_intent_create_params.rb +61 -57
- data/lib/stripe/params/payment_intent_decrement_authorization_params.rb +4 -4
- data/lib/stripe/params/payment_intent_increment_authorization_params.rb +10 -10
- data/lib/stripe/params/payment_intent_list_params.rb +1 -1
- data/lib/stripe/params/payment_intent_search_params.rb +1 -1
- data/lib/stripe/params/payment_intent_update_params.rb +40 -40
- data/lib/stripe/params/payment_link_create_params.rb +32 -20
- data/lib/stripe/params/payment_link_update_params.rb +9 -9
- data/lib/stripe/params/payment_method_attach_params.rb +1 -1
- data/lib/stripe/params/payment_method_configuration_create_params.rb +40 -40
- data/lib/stripe/params/payment_method_configuration_update_params.rb +40 -40
- data/lib/stripe/params/payment_method_create_params.rb +4 -4
- data/lib/stripe/params/payment_method_update_params.rb +2 -2
- data/lib/stripe/params/payment_record_report_payment_attempt_informational_params.rb +2 -2
- data/lib/stripe/params/payment_record_report_payment_attempt_params.rb +3 -3
- data/lib/stripe/params/payment_record_report_payment_params.rb +4 -4
- data/lib/stripe/params/payment_record_report_refund_params.rb +3 -3
- data/lib/stripe/params/payout_create_params.rb +1 -1
- data/lib/stripe/params/payout_reverse_params.rb +1 -1
- data/lib/stripe/params/payout_update_params.rb +1 -1
- data/lib/stripe/params/plan_create_params.rb +4 -4
- data/lib/stripe/params/plan_update_params.rb +2 -2
- data/lib/stripe/params/price_create_params.rb +6 -6
- data/lib/stripe/params/price_search_params.rb +1 -1
- data/lib/stripe/params/price_update_params.rb +3 -3
- data/lib/stripe/params/product_create_params.rb +21 -8
- data/lib/stripe/params/product_feature_create_params.rb +1 -1
- data/lib/stripe/params/product_list_params.rb +1 -1
- data/lib/stripe/params/product_search_params.rb +1 -1
- data/lib/stripe/params/product_update_params.rb +18 -5
- data/lib/stripe/params/promotion_code_create_params.rb +3 -3
- data/lib/stripe/params/promotion_code_list_params.rb +1 -1
- data/lib/stripe/params/promotion_code_update_params.rb +1 -1
- data/lib/stripe/params/quote_create_params.rb +14 -14
- data/lib/stripe/params/quote_list_params.rb +2 -2
- data/lib/stripe/params/quote_update_params.rb +14 -14
- data/lib/stripe/params/radar/value_list_create_params.rb +1 -1
- data/lib/stripe/params/radar/value_list_update_params.rb +1 -1
- data/lib/stripe/params/refund_create_params.rb +2 -2
- data/lib/stripe/params/refund_update_params.rb +1 -1
- data/lib/stripe/params/reporting/report_run_create_params.rb +2 -2
- data/lib/stripe/params/setup_intent_confirm_params.rb +6 -6
- data/lib/stripe/params/setup_intent_create_params.rb +12 -12
- data/lib/stripe/params/setup_intent_update_params.rb +8 -8
- data/lib/stripe/params/shared_payment/granted_token_create_params.rb +47 -0
- data/lib/stripe/params/shared_payment/granted_token_retrieve_params.rb +15 -0
- data/lib/stripe/params/shared_payment/granted_token_update_params.rb +15 -0
- data/lib/stripe/params/shipping_rate_create_params.rb +2 -2
- data/lib/stripe/params/shipping_rate_update_params.rb +1 -1
- data/lib/stripe/params/source_create_params.rb +3 -3
- data/lib/stripe/params/source_update_params.rb +3 -3
- data/lib/stripe/params/subscription_create_params.rb +51 -27
- data/lib/stripe/params/subscription_item_create_params.rb +15 -15
- data/lib/stripe/params/subscription_item_delete_params.rb +2 -2
- data/lib/stripe/params/subscription_item_update_params.rb +15 -15
- data/lib/stripe/params/subscription_list_params.rb +3 -3
- data/lib/stripe/params/subscription_resume_params.rb +2 -2
- data/lib/stripe/params/subscription_schedule_amend_params.rb +10 -10
- data/lib/stripe/params/subscription_schedule_create_params.rb +31 -31
- data/lib/stripe/params/subscription_schedule_update_params.rb +31 -31
- data/lib/stripe/params/subscription_search_params.rb +1 -1
- data/lib/stripe/params/subscription_update_params.rb +49 -25
- data/lib/stripe/params/tax/association_find_params.rb +1 -1
- data/lib/stripe/params/tax/calculation_create_params.rb +7 -7
- data/lib/stripe/params/tax/settings_update_params.rb +1 -1
- data/lib/stripe/params/tax/transaction_create_from_calculation_params.rb +1 -1
- data/lib/stripe/params/tax/transaction_create_reversal_params.rb +9 -9
- data/lib/stripe/params/tax_id_create_params.rb +2 -2
- data/lib/stripe/params/tax_id_list_params.rb +2 -2
- data/lib/stripe/params/tax_rate_create_params.rb +1 -1
- data/lib/stripe/params/tax_rate_update_params.rb +1 -1
- data/lib/stripe/params/terminal/location_create_params.rb +2 -2
- data/lib/stripe/params/terminal/location_update_params.rb +2 -2
- data/lib/stripe/params/terminal/reader_collect_inputs_params.rb +1 -1
- data/lib/stripe/params/terminal/reader_create_params.rb +1 -1
- data/lib/stripe/params/terminal/reader_refund_payment_params.rb +1 -1
- data/lib/stripe/params/terminal/reader_set_reader_display_params.rb +3 -3
- data/lib/stripe/params/terminal/reader_update_params.rb +1 -1
- data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +6 -6
- data/lib/stripe/params/test_helpers/customer_fund_cash_balance_params.rb +2 -2
- data/lib/stripe/params/test_helpers/issuing/authorization_capture_params.rb +1 -1
- data/lib/stripe/params/test_helpers/issuing/authorization_create_params.rb +5 -5
- data/lib/stripe/params/test_helpers/issuing/authorization_finalize_amount_params.rb +1 -1
- data/lib/stripe/params/test_helpers/issuing/authorization_increment_params.rb +2 -2
- data/lib/stripe/params/test_helpers/issuing/authorization_reverse_params.rb +1 -1
- data/lib/stripe/params/test_helpers/issuing/transaction_create_force_capture_params.rb +2 -2
- data/lib/stripe/params/test_helpers/issuing/transaction_create_unlinked_refund_params.rb +2 -2
- data/lib/stripe/params/test_helpers/issuing/transaction_refund_params.rb +1 -1
- data/lib/stripe/params/test_helpers/shared_payment/granted_token_create_params.rb +49 -0
- data/lib/stripe/params/test_helpers/shared_payment/granted_token_update_params.rb +17 -0
- data/lib/stripe/params/test_helpers/treasury/received_credit_create_params.rb +1 -1
- data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +1 -1
- data/lib/stripe/params/token_create_params.rb +22 -22
- data/lib/stripe/params/topup_create_params.rb +2 -2
- data/lib/stripe/params/topup_update_params.rb +1 -1
- data/lib/stripe/params/transfer_create_params.rb +3 -3
- data/lib/stripe/params/transfer_reversal_create_params.rb +1 -1
- data/lib/stripe/params/transfer_reversal_update_params.rb +1 -1
- data/lib/stripe/params/transfer_update_params.rb +1 -1
- data/lib/stripe/params/treasury/credit_reversal_create_params.rb +1 -1
- data/lib/stripe/params/treasury/debit_reversal_create_params.rb +1 -1
- data/lib/stripe/params/treasury/financial_account_create_params.rb +1 -1
- data/lib/stripe/params/treasury/financial_account_update_params.rb +1 -1
- data/lib/stripe/params/treasury/inbound_transfer_create_params.rb +2 -2
- data/lib/stripe/params/treasury/outbound_payment_create_params.rb +5 -5
- data/lib/stripe/params/treasury/outbound_transfer_create_params.rb +3 -3
- data/lib/stripe/params/treasury/received_credit_create_params.rb +1 -1
- data/lib/stripe/params/treasury/received_debit_create_params.rb +1 -1
- data/lib/stripe/params/v2/billing/intent_create_params.rb +110 -40
- data/lib/stripe/params/v2/core/account_create_params.rb +36 -24
- data/lib/stripe/params/v2/core/account_link_create_params.rb +5 -5
- data/lib/stripe/params/v2/core/account_token_create_params.rb +8 -8
- data/lib/stripe/params/v2/core/account_update_params.rb +41 -29
- data/lib/stripe/params/v2/core/accounts/person_create_params.rb +5 -5
- data/lib/stripe/params/v2/core/accounts/person_token_create_params.rb +5 -5
- data/lib/stripe/params/v2/core/accounts/person_update_params.rb +5 -5
- data/lib/stripe/params/v2/core/claimable_sandbox_create_params.rb +1 -1
- data/lib/stripe/params/v2/iam/api_key_create_params.rb +51 -0
- data/lib/stripe/params/v2/iam/api_key_expire_params.rb +10 -0
- data/lib/stripe/params/v2/iam/api_key_list_params.rb +20 -0
- data/lib/stripe/params/v2/iam/api_key_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/iam/api_key_rotate_params.rb +46 -0
- data/lib/stripe/params/v2/iam/api_key_update_params.rb +20 -0
- data/lib/stripe/params/v2/money_management/financial_account_list_params.rb +4 -1
- data/lib/stripe/params/v2/money_management/outbound_payment_create_params.rb +4 -1
- data/lib/stripe/params/v2/money_management/outbound_payment_quote_create_params.rb +4 -1
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_cancel_params.rb +10 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_create_params.rb +46 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_submit_params.rb +10 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_update_params.rb +31 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intents/split_cancel_params.rb +12 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intents/split_create_params.rb +39 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intents/split_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/tax/manual_rule_create_params.rb +94 -0
- data/lib/stripe/params/v2/tax/manual_rule_deactivate_params.rb +10 -0
- data/lib/stripe/params/v2/tax/manual_rule_list_params.rb +17 -0
- data/lib/stripe/params/v2/tax/manual_rule_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/tax/manual_rule_update_params.rb +94 -0
- data/lib/stripe/params/webhook_endpoint_create_params.rb +1 -1
- data/lib/stripe/params/webhook_endpoint_update_params.rb +1 -1
- data/lib/stripe/params.rb +24 -0
- data/lib/stripe/resources/account.rb +27 -27
- data/lib/stripe/resources/account_link.rb +1 -1
- data/lib/stripe/resources/account_notice.rb +6 -6
- data/lib/stripe/resources/account_session.rb +5 -5
- data/lib/stripe/resources/application_fee_refund.rb +2 -2
- data/lib/stripe/resources/apps/secret.rb +1 -1
- data/lib/stripe/resources/balance.rb +2 -2
- data/lib/stripe/resources/balance_settings.rb +1 -1
- data/lib/stripe/resources/balance_transaction.rb +1 -1
- data/lib/stripe/resources/balance_transfer.rb +3 -3
- data/lib/stripe/resources/bank_account.rb +10 -10
- data/lib/stripe/resources/billing/alert.rb +2 -2
- data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -2
- data/lib/stripe/resources/billing/credit_balance_transaction.rb +2 -2
- data/lib/stripe/resources/billing/credit_grant.rb +3 -3
- data/lib/stripe/resources/billing/meter_event.rb +1 -1
- data/lib/stripe/resources/billing_portal/configuration.rb +5 -3
- data/lib/stripe/resources/billing_portal/session.rb +6 -6
- data/lib/stripe/resources/capability.rb +16 -16
- data/lib/stripe/resources/capital/financing_offer.rb +2 -2
- data/lib/stripe/resources/capital/financing_summary.rb +7 -4
- data/lib/stripe/resources/card.rb +2 -2
- data/lib/stripe/resources/cash_balance.rb +2 -2
- data/lib/stripe/resources/charge.rb +47 -35
- data/lib/stripe/resources/checkout/session.rb +19 -19
- data/lib/stripe/resources/climate/order.rb +1 -1
- data/lib/stripe/resources/confirmation_token.rb +11 -11
- data/lib/stripe/resources/coupon.rb +3 -3
- data/lib/stripe/resources/credit_note.rb +5 -5
- data/lib/stripe/resources/credit_note_line_item.rb +1 -1
- data/lib/stripe/resources/customer.rb +8 -8
- data/lib/stripe/resources/customer_balance_transaction.rb +6 -6
- data/lib/stripe/resources/customer_cash_balance_transaction.rb +10 -10
- data/lib/stripe/resources/delegated_checkout/requested_session.rb +63 -10
- data/lib/stripe/resources/discount.rb +5 -5
- data/lib/stripe/resources/dispute.rb +5 -5
- data/lib/stripe/resources/entitlements/active_entitlement.rb +1 -1
- data/lib/stripe/resources/event.rb +1 -1
- data/lib/stripe/resources/exchange_rate.rb +2 -2
- data/lib/stripe/resources/file.rb +4 -4
- data/lib/stripe/resources/file_link.rb +1 -1
- data/lib/stripe/resources/financial_connections/account.rb +3 -3
- data/lib/stripe/resources/financial_connections/session.rb +2 -2
- data/lib/stripe/resources/forwarding/request.rb +1 -1
- data/lib/stripe/resources/funding_instructions.rb +14 -14
- data/lib/stripe/resources/identity/blocklist_entry.rb +1 -1
- data/lib/stripe/resources/identity/verification_report.rb +9 -9
- data/lib/stripe/resources/identity/verification_session.rb +11 -11
- data/lib/stripe/resources/invoice.rb +66 -34
- data/lib/stripe/resources/invoice_item.rb +9 -9
- data/lib/stripe/resources/invoice_line_item.rb +7 -7
- data/lib/stripe/resources/invoice_payment.rb +1 -1
- data/lib/stripe/resources/invoice_rendering_template.rb +1 -1
- data/lib/stripe/resources/issuing/authorization.rb +20 -20
- data/lib/stripe/resources/issuing/card.rb +16 -12
- data/lib/stripe/resources/issuing/cardholder.rb +14 -14
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +5 -5
- data/lib/stripe/resources/issuing/dispute.rb +7 -7
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +1 -1
- data/lib/stripe/resources/issuing/personalization_design.rb +1 -1
- data/lib/stripe/resources/issuing/program.rb +1 -1
- data/lib/stripe/resources/issuing/settlement.rb +2 -2
- data/lib/stripe/resources/issuing/token.rb +1 -1
- data/lib/stripe/resources/issuing/transaction.rb +13 -13
- data/lib/stripe/resources/line_item.rb +3 -3
- data/lib/stripe/resources/login_link.rb +1 -1
- data/lib/stripe/resources/margin.rb +1 -1
- data/lib/stripe/resources/order.rb +13 -13
- data/lib/stripe/resources/payment_attempt_record.rb +80 -22
- data/lib/stripe/resources/payment_intent.rb +117 -74
- data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +3 -3
- data/lib/stripe/resources/payment_link.rb +7 -7
- data/lib/stripe/resources/payment_method.rb +13 -13
- data/lib/stripe/resources/payment_method_configuration.rb +4 -4
- data/lib/stripe/resources/payment_method_domain.rb +1 -1
- data/lib/stripe/resources/payment_record.rb +82 -22
- data/lib/stripe/resources/payout.rb +7 -7
- data/lib/stripe/resources/person.rb +23 -23
- data/lib/stripe/resources/plan.rb +5 -5
- data/lib/stripe/resources/price.rb +6 -6
- data/lib/stripe/resources/product.rb +9 -9
- data/lib/stripe/resources/promotion_code.rb +4 -4
- data/lib/stripe/resources/quote.rb +15 -15
- data/lib/stripe/resources/quote_line.rb +5 -5
- data/lib/stripe/resources/quote_preview_invoice.rb +64 -32
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +100 -100
- data/lib/stripe/resources/radar/early_fraud_warning.rb +1 -1
- data/lib/stripe/resources/radar/value_list.rb +2 -2
- data/lib/stripe/resources/radar/value_list_item.rb +1 -1
- data/lib/stripe/resources/refund.rb +3 -3
- data/lib/stripe/resources/reporting/report_run.rb +3 -3
- data/lib/stripe/resources/reporting/report_type.rb +3 -3
- data/lib/stripe/resources/reversal.rb +4 -4
- data/lib/stripe/resources/review.rb +1 -1
- data/lib/stripe/resources/setup_attempt.rb +17 -17
- data/lib/stripe/resources/setup_intent.rb +19 -19
- data/lib/stripe/resources/shared_payment/granted_token.rb +126 -0
- data/lib/stripe/resources/shipping_rate.rb +3 -3
- data/lib/stripe/resources/sigma/scheduled_query_run.rb +1 -1
- data/lib/stripe/resources/source.rb +8 -8
- data/lib/stripe/resources/source_mandate_notification.rb +3 -3
- data/lib/stripe/resources/subscription.rb +46 -14
- data/lib/stripe/resources/subscription_item.rb +22 -22
- data/lib/stripe/resources/subscription_schedule.rb +101 -101
- data/lib/stripe/resources/tax/association.rb +3 -3
- data/lib/stripe/resources/tax/calculation.rb +12 -12
- data/lib/stripe/resources/tax/calculation_line_item.rb +7 -7
- data/lib/stripe/resources/tax/registration.rb +3 -3
- data/lib/stripe/resources/tax/settings.rb +2 -2
- data/lib/stripe/resources/tax/transaction.rb +9 -9
- data/lib/stripe/resources/tax/transaction_line_item.rb +5 -5
- data/lib/stripe/resources/tax_id.rb +4 -4
- data/lib/stripe/resources/tax_rate.rb +1 -1
- data/lib/stripe/resources/terminal/connection_token.rb +1 -1
- data/lib/stripe/resources/terminal/location.rb +3 -3
- data/lib/stripe/resources/terminal/reader.rb +10 -10
- data/lib/stripe/resources/token.rb +4 -4
- data/lib/stripe/resources/topup.rb +3 -3
- data/lib/stripe/resources/transfer.rb +5 -5
- data/lib/stripe/resources/treasury/credit_reversal.rb +3 -3
- data/lib/stripe/resources/treasury/debit_reversal.rb +3 -3
- data/lib/stripe/resources/treasury/financial_account.rb +1 -1
- data/lib/stripe/resources/treasury/inbound_transfer.rb +5 -5
- data/lib/stripe/resources/treasury/outbound_payment.rb +6 -6
- data/lib/stripe/resources/treasury/outbound_transfer.rb +5 -5
- data/lib/stripe/resources/treasury/received_credit.rb +10 -10
- data/lib/stripe/resources/treasury/received_debit.rb +7 -7
- data/lib/stripe/resources/treasury/transaction.rb +11 -11
- data/lib/stripe/resources/treasury/transaction_entry.rb +11 -11
- data/lib/stripe/resources/v2/billing/intent_action.rb +139 -51
- data/lib/stripe/resources/v2/core/account.rb +174 -289
- data/lib/stripe/resources/v2/core/account_link.rb +11 -11
- data/lib/stripe/resources/v2/core/account_person.rb +10 -10
- data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +21 -1
- data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +23 -1
- data/lib/stripe/resources/v2/iam/api_key.rb +129 -0
- data/lib/stripe/resources/v2/money_management/financial_account.rb +35 -0
- data/lib/stripe/resources/v2/money_management/outbound_payment.rb +2 -0
- data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +2 -0
- data/lib/stripe/resources/v2/money_management/payout_method.rb +20 -0
- data/lib/stripe/resources/v2/money_management/received_credit.rb +2 -0
- data/lib/stripe/resources/v2/payments/settlement_allocation_intent.rb +92 -0
- data/lib/stripe/resources/v2/payments/settlement_allocation_intent_split.rb +78 -0
- data/lib/stripe/resources/v2/tax/manual_rule.rb +115 -0
- data/lib/stripe/resources/webhook_endpoint.rb +1 -1
- data/lib/stripe/resources.rb +19 -0
- data/lib/stripe/services/capital/financing_summary_service.rb +1 -1
- data/lib/stripe/services/payment_method_service.rb +1 -1
- data/lib/stripe/services/shared_payment/granted_token_service.rb +19 -0
- data/lib/stripe/services/shared_payment_service.rb +13 -0
- data/lib/stripe/services/test_helpers/shared_payment/granted_token_service.rb +32 -0
- data/lib/stripe/services/test_helpers/shared_payment_service.rb +15 -0
- data/lib/stripe/services/test_helpers_service.rb +2 -1
- data/lib/stripe/services/v1_services.rb +2 -1
- data/lib/stripe/services/v2/core/account_link_service.rb +1 -1
- data/lib/stripe/services/v2/core/account_service.rb +0 -4
- data/lib/stripe/services/v2/core/accounts/person_service.rb +2 -2
- data/lib/stripe/services/v2/iam/api_key_service.rb +76 -0
- data/lib/stripe/services/v2/iam_service.rb +15 -0
- data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +2 -0
- data/lib/stripe/services/v2/money_management/payout_method_service.rb +2 -0
- data/lib/stripe/services/v2/payment_service.rb +3 -1
- data/lib/stripe/services/v2/payments/settlement_allocation_intent_service.rb +72 -0
- data/lib/stripe/services/v2/payments/settlement_allocation_intents/split_service.rb +45 -0
- data/lib/stripe/services/v2/tax/manual_rule_service.rb +65 -0
- data/lib/stripe/services/v2/tax_service.rb +15 -0
- data/lib/stripe/services/v2_services.rb +3 -1
- data/lib/stripe/services.rb +10 -0
- data/lib/stripe/stripe_object.rb +11 -3
- data/lib/stripe/version.rb +1 -1
- data/rbi/stripe.rbi +6022 -3221
- metadata +55 -2
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
5
|
# The `Charge` object represents a single attempt to move money into your Stripe account.
|
|
6
|
-
# PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://stripe.com/
|
|
6
|
+
# PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://docs.stripe.com/connect/account-debits) may also create Charges.
|
|
7
7
|
# Some legacy payment flows create Charges directly, which is not recommended for new integrations.
|
|
8
8
|
class Charge < APIResource
|
|
9
9
|
extend Stripe::APIOperations::Create
|
|
@@ -31,7 +31,7 @@ module Stripe
|
|
|
31
31
|
attr_reader :line2
|
|
32
32
|
# ZIP or postal code.
|
|
33
33
|
attr_reader :postal_code
|
|
34
|
-
# State, county, province, or region.
|
|
34
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
35
35
|
attr_reader :state
|
|
36
36
|
|
|
37
37
|
def self.inner_class_types
|
|
@@ -139,15 +139,15 @@ module Stripe
|
|
|
139
139
|
@field_remappings = {}
|
|
140
140
|
end
|
|
141
141
|
end
|
|
142
|
-
# An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/
|
|
142
|
+
# An enumerated value providing a more detailed explanation on [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines).
|
|
143
143
|
attr_reader :advice_code
|
|
144
144
|
# For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.
|
|
145
145
|
attr_reader :network_advice_code
|
|
146
146
|
# For charges declined by the network, an alphanumeric code which indicates the reason the charge failed.
|
|
147
147
|
attr_reader :network_decline_code
|
|
148
|
-
# Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/
|
|
148
|
+
# Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://docs.stripe.com/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.
|
|
149
149
|
attr_reader :network_status
|
|
150
|
-
# An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/
|
|
150
|
+
# An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://docs.stripe.com/declines) for more details.
|
|
151
151
|
attr_reader :reason
|
|
152
152
|
# Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar.
|
|
153
153
|
attr_reader :risk_level
|
|
@@ -157,7 +157,7 @@ module Stripe
|
|
|
157
157
|
attr_reader :rule
|
|
158
158
|
# A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.
|
|
159
159
|
attr_reader :seller_message
|
|
160
|
-
# Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/
|
|
160
|
+
# Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://docs.stripe.com/declines) and [Radar reviews](https://docs.stripe.com/radar/reviews) for details.
|
|
161
161
|
attr_reader :type
|
|
162
162
|
|
|
163
163
|
def self.inner_class_types
|
|
@@ -215,6 +215,8 @@ module Stripe
|
|
|
215
215
|
class AcssDebit < ::Stripe::StripeObject
|
|
216
216
|
# Name of the bank associated with the bank account.
|
|
217
217
|
attr_reader :bank_name
|
|
218
|
+
# Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
|
|
219
|
+
attr_reader :expected_debit_date
|
|
218
220
|
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
|
|
219
221
|
attr_reader :fingerprint
|
|
220
222
|
# Institution number of the bank account
|
|
@@ -236,9 +238,9 @@ module Stripe
|
|
|
236
238
|
end
|
|
237
239
|
|
|
238
240
|
class Affirm < ::Stripe::StripeObject
|
|
239
|
-
# ID of the [location](https://stripe.com/
|
|
241
|
+
# ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to.
|
|
240
242
|
attr_reader :location
|
|
241
|
-
# ID of the [reader](https://stripe.com/
|
|
243
|
+
# ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on.
|
|
242
244
|
attr_reader :reader
|
|
243
245
|
# The Affirm transaction ID associated with this payment.
|
|
244
246
|
attr_reader :transaction_id
|
|
@@ -367,6 +369,8 @@ module Stripe
|
|
|
367
369
|
class AuBecsDebit < ::Stripe::StripeObject
|
|
368
370
|
# Bank-State-Branch number of the bank account.
|
|
369
371
|
attr_reader :bsb_number
|
|
372
|
+
# Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
|
|
373
|
+
attr_reader :expected_debit_date
|
|
370
374
|
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
|
|
371
375
|
attr_reader :fingerprint
|
|
372
376
|
# Last four digits of the bank account number.
|
|
@@ -384,6 +388,8 @@ module Stripe
|
|
|
384
388
|
end
|
|
385
389
|
|
|
386
390
|
class BacsDebit < ::Stripe::StripeObject
|
|
391
|
+
# Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
|
|
392
|
+
attr_reader :expected_debit_date
|
|
387
393
|
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
|
|
388
394
|
attr_reader :fingerprint
|
|
389
395
|
# Last four digits of the bank account number.
|
|
@@ -709,7 +715,7 @@ module Stripe
|
|
|
709
715
|
attr_reader :line2
|
|
710
716
|
# ZIP or postal code.
|
|
711
717
|
attr_reader :postal_code
|
|
712
|
-
# State, county, province, or region.
|
|
718
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
713
719
|
attr_reader :state
|
|
714
720
|
|
|
715
721
|
def self.inner_class_types
|
|
@@ -732,7 +738,7 @@ module Stripe
|
|
|
732
738
|
attr_reader :line2
|
|
733
739
|
# ZIP or postal code.
|
|
734
740
|
attr_reader :postal_code
|
|
735
|
-
# State, county, province, or region.
|
|
741
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
736
742
|
attr_reader :state
|
|
737
743
|
|
|
738
744
|
def self.inner_class_types
|
|
@@ -786,7 +792,7 @@ module Stripe
|
|
|
786
792
|
attr_reader :line2
|
|
787
793
|
# ZIP or postal code.
|
|
788
794
|
attr_reader :postal_code
|
|
789
|
-
# State, county, province, or region.
|
|
795
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
790
796
|
attr_reader :state
|
|
791
797
|
|
|
792
798
|
def self.inner_class_types
|
|
@@ -809,7 +815,7 @@ module Stripe
|
|
|
809
815
|
attr_reader :line2
|
|
810
816
|
# ZIP or postal code.
|
|
811
817
|
attr_reader :postal_code
|
|
812
|
-
# State, county, province, or region.
|
|
818
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
813
819
|
attr_reader :state
|
|
814
820
|
|
|
815
821
|
def self.inner_class_types
|
|
@@ -913,7 +919,7 @@ module Stripe
|
|
|
913
919
|
attr_reader :incremental_authorization
|
|
914
920
|
# Installment details for this payment.
|
|
915
921
|
#
|
|
916
|
-
# For more information, see the [installments integration guide](https://stripe.com/
|
|
922
|
+
# For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments).
|
|
917
923
|
attr_reader :installments
|
|
918
924
|
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
|
|
919
925
|
attr_reader :issuer
|
|
@@ -1051,7 +1057,7 @@ module Stripe
|
|
|
1051
1057
|
attr_reader :generated_card
|
|
1052
1058
|
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
|
|
1053
1059
|
attr_reader :iin
|
|
1054
|
-
# Whether this [PaymentIntent](https://stripe.com/
|
|
1060
|
+
# Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
|
|
1055
1061
|
attr_reader :incremental_authorization_supported
|
|
1056
1062
|
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
|
|
1057
1063
|
attr_reader :issuer
|
|
@@ -1229,7 +1235,7 @@ module Stripe
|
|
|
1229
1235
|
end
|
|
1230
1236
|
|
|
1231
1237
|
class Ideal < ::Stripe::StripeObject
|
|
1232
|
-
# The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
|
|
1238
|
+
# The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
|
|
1233
1239
|
attr_reader :bank
|
|
1234
1240
|
# The Bank Identifier Code of the customer's bank.
|
|
1235
1241
|
attr_reader :bic
|
|
@@ -1529,6 +1535,8 @@ module Stripe
|
|
|
1529
1535
|
attr_reader :bank_name
|
|
1530
1536
|
# The numeric code for the bank account's bank branch.
|
|
1531
1537
|
attr_reader :branch_code
|
|
1538
|
+
# Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
|
|
1539
|
+
attr_reader :expected_debit_date
|
|
1532
1540
|
# Last four digits of the bank account number.
|
|
1533
1541
|
attr_reader :last4
|
|
1534
1542
|
# The suffix of the bank account number.
|
|
@@ -1601,9 +1609,9 @@ module Stripe
|
|
|
1601
1609
|
end
|
|
1602
1610
|
|
|
1603
1611
|
class Paynow < ::Stripe::StripeObject
|
|
1604
|
-
# ID of the [location](https://stripe.com/
|
|
1612
|
+
# ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to.
|
|
1605
1613
|
attr_reader :location
|
|
1606
|
-
# ID of the [reader](https://stripe.com/
|
|
1614
|
+
# ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on.
|
|
1607
1615
|
attr_reader :reader
|
|
1608
1616
|
# Reference number associated with this PayNow payment
|
|
1609
1617
|
attr_reader :reference
|
|
@@ -1644,7 +1652,7 @@ module Stripe
|
|
|
1644
1652
|
attr_reader :line2
|
|
1645
1653
|
# ZIP or postal code.
|
|
1646
1654
|
attr_reader :postal_code
|
|
1647
|
-
# State, county, province, or region.
|
|
1655
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
1648
1656
|
attr_reader :state
|
|
1649
1657
|
|
|
1650
1658
|
def self.inner_class_types
|
|
@@ -1667,7 +1675,7 @@ module Stripe
|
|
|
1667
1675
|
attr_reader :line2
|
|
1668
1676
|
# ZIP or postal code.
|
|
1669
1677
|
attr_reader :postal_code
|
|
1670
|
-
# State, county, province, or region.
|
|
1678
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
1671
1679
|
attr_reader :state
|
|
1672
1680
|
|
|
1673
1681
|
def self.inner_class_types
|
|
@@ -1905,11 +1913,13 @@ module Stripe
|
|
|
1905
1913
|
attr_reader :branch_code
|
|
1906
1914
|
# Two-letter ISO code representing the country the bank account is located in.
|
|
1907
1915
|
attr_reader :country
|
|
1916
|
+
# Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
|
|
1917
|
+
attr_reader :expected_debit_date
|
|
1908
1918
|
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
|
|
1909
1919
|
attr_reader :fingerprint
|
|
1910
1920
|
# Last four characters of the IBAN.
|
|
1911
1921
|
attr_reader :last4
|
|
1912
|
-
# Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/
|
|
1922
|
+
# Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://docs.stripe.com/api/mandates/retrieve).
|
|
1913
1923
|
attr_reader :mandate
|
|
1914
1924
|
|
|
1915
1925
|
def self.inner_class_types
|
|
@@ -2021,6 +2031,8 @@ module Stripe
|
|
|
2021
2031
|
attr_reader :account_type
|
|
2022
2032
|
# Name of the bank associated with the bank account.
|
|
2023
2033
|
attr_reader :bank_name
|
|
2034
|
+
# Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
|
|
2035
|
+
attr_reader :expected_debit_date
|
|
2024
2036
|
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
|
|
2025
2037
|
attr_reader :fingerprint
|
|
2026
2038
|
# Last four digits of the bank account number.
|
|
@@ -2054,9 +2066,9 @@ module Stripe
|
|
|
2054
2066
|
class WechatPay < ::Stripe::StripeObject
|
|
2055
2067
|
# Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.
|
|
2056
2068
|
attr_reader :fingerprint
|
|
2057
|
-
# ID of the [location](https://stripe.com/
|
|
2069
|
+
# ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to.
|
|
2058
2070
|
attr_reader :location
|
|
2059
|
-
# ID of the [reader](https://stripe.com/
|
|
2071
|
+
# ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on.
|
|
2060
2072
|
attr_reader :reader
|
|
2061
2073
|
# Transaction ID of this particular WeChat Pay transaction.
|
|
2062
2074
|
attr_reader :transaction_id
|
|
@@ -2199,7 +2211,7 @@ module Stripe
|
|
|
2199
2211
|
attr_reader :swish
|
|
2200
2212
|
# Attribute for field twint
|
|
2201
2213
|
attr_reader :twint
|
|
2202
|
-
# The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/
|
|
2214
|
+
# The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) for the full list of possible types.
|
|
2203
2215
|
# An additional hash is included on `payment_method_details` with a name matching this value.
|
|
2204
2216
|
# It contains information specific to the payment method.
|
|
2205
2217
|
attr_reader :type
|
|
@@ -2302,7 +2314,7 @@ module Stripe
|
|
|
2302
2314
|
end
|
|
2303
2315
|
|
|
2304
2316
|
class RadarOptions < ::Stripe::StripeObject
|
|
2305
|
-
# A [Radar Session](https://stripe.com/
|
|
2317
|
+
# A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
|
|
2306
2318
|
attr_reader :session
|
|
2307
2319
|
|
|
2308
2320
|
def self.inner_class_types
|
|
@@ -2326,7 +2338,7 @@ module Stripe
|
|
|
2326
2338
|
attr_reader :line2
|
|
2327
2339
|
# ZIP or postal code.
|
|
2328
2340
|
attr_reader :postal_code
|
|
2329
|
-
# State, county, province, or region.
|
|
2341
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
2330
2342
|
attr_reader :state
|
|
2331
2343
|
|
|
2332
2344
|
def self.inner_class_types
|
|
@@ -2373,7 +2385,7 @@ module Stripe
|
|
|
2373
2385
|
end
|
|
2374
2386
|
# Funds that are in transit and destined for another balance or another connected account.
|
|
2375
2387
|
attr_reader :allocated_funds
|
|
2376
|
-
# Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/
|
|
2388
|
+
# Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
|
|
2377
2389
|
attr_reader :amount
|
|
2378
2390
|
# Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).
|
|
2379
2391
|
attr_reader :amount_captured
|
|
@@ -2381,9 +2393,9 @@ module Stripe
|
|
|
2381
2393
|
attr_reader :amount_refunded
|
|
2382
2394
|
# ID of the Connect application that created the charge.
|
|
2383
2395
|
attr_reader :application
|
|
2384
|
-
# The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/
|
|
2396
|
+
# The application fee (if any) for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details.
|
|
2385
2397
|
attr_reader :application_fee
|
|
2386
|
-
# The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/
|
|
2398
|
+
# The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details.
|
|
2387
2399
|
attr_reader :application_fee_amount
|
|
2388
2400
|
# Authorization code on the charge.
|
|
2389
2401
|
attr_reader :authorization_code
|
|
@@ -2407,7 +2419,7 @@ module Stripe
|
|
|
2407
2419
|
attr_reader :disputed
|
|
2408
2420
|
# ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
|
|
2409
2421
|
attr_reader :failure_balance_transaction
|
|
2410
|
-
# Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/
|
|
2422
|
+
# Error code explaining reason for charge failure if available (see [the errors section](https://docs.stripe.com/error-codes) for a list of codes).
|
|
2411
2423
|
attr_reader :failure_code
|
|
2412
2424
|
# Message to user further explaining reason for charge failure if available.
|
|
2413
2425
|
attr_reader :failure_message
|
|
@@ -2419,13 +2431,13 @@ module Stripe
|
|
|
2419
2431
|
attr_reader :level3
|
|
2420
2432
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
2421
2433
|
attr_reader :livemode
|
|
2422
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
2434
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
2423
2435
|
attr_reader :metadata
|
|
2424
2436
|
# String representing the object's type. Objects of the same type share the same value.
|
|
2425
2437
|
attr_reader :object
|
|
2426
|
-
# The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/
|
|
2438
|
+
# The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers) for details.
|
|
2427
2439
|
attr_reader :on_behalf_of
|
|
2428
|
-
# Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/
|
|
2440
|
+
# Details about whether the payment was accepted, and why. See [understanding declines](https://docs.stripe.com/declines) for details.
|
|
2429
2441
|
attr_reader :outcome
|
|
2430
2442
|
# `true` if the charge succeeded, or was successfully authorized for later capture.
|
|
2431
2443
|
attr_reader :paid
|
|
@@ -2437,7 +2449,7 @@ module Stripe
|
|
|
2437
2449
|
attr_reader :payment_method_details
|
|
2438
2450
|
# Attribute for field presentment_details
|
|
2439
2451
|
attr_reader :presentment_details
|
|
2440
|
-
# Options to configure Radar. See [Radar Session](https://stripe.com/
|
|
2452
|
+
# Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.
|
|
2441
2453
|
attr_reader :radar_options
|
|
2442
2454
|
# This is the email address that the receipt for this charge was sent to.
|
|
2443
2455
|
attr_reader :receipt_email
|
|
@@ -2467,9 +2479,9 @@ module Stripe
|
|
|
2467
2479
|
attr_reader :status
|
|
2468
2480
|
# ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).
|
|
2469
2481
|
attr_reader :transfer
|
|
2470
|
-
# An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/
|
|
2482
|
+
# An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.
|
|
2471
2483
|
attr_reader :transfer_data
|
|
2472
|
-
# A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/
|
|
2484
|
+
# A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details.
|
|
2473
2485
|
attr_reader :transfer_group
|
|
2474
2486
|
|
|
2475
2487
|
# Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
|
|
@@ -4,19 +4,19 @@
|
|
|
4
4
|
module Stripe
|
|
5
5
|
module Checkout
|
|
6
6
|
# A Checkout Session represents your customer's session as they pay for
|
|
7
|
-
# one-time purchases or subscriptions through [Checkout](https://stripe.com/
|
|
8
|
-
# or [Payment Links](https://stripe.com/
|
|
7
|
+
# one-time purchases or subscriptions through [Checkout](https://docs.stripe.com/payments/checkout)
|
|
8
|
+
# or [Payment Links](https://docs.stripe.com/payments/payment-links). We recommend creating a
|
|
9
9
|
# new Session each time your customer attempts to pay.
|
|
10
10
|
#
|
|
11
11
|
# Once payment is successful, the Checkout Session will contain a reference
|
|
12
|
-
# to the [Customer](https://stripe.com/
|
|
13
|
-
# [PaymentIntent](https://stripe.com/
|
|
14
|
-
# [Subscription](https://stripe.com/
|
|
12
|
+
# to the [Customer](https://docs.stripe.com/api/customers), and either the successful
|
|
13
|
+
# [PaymentIntent](https://docs.stripe.com/api/payment_intents) or an active
|
|
14
|
+
# [Subscription](https://docs.stripe.com/api/subscriptions).
|
|
15
15
|
#
|
|
16
16
|
# You can create a Checkout Session on your server and redirect to its URL
|
|
17
17
|
# to begin Checkout.
|
|
18
18
|
#
|
|
19
|
-
# Related guide: [Checkout quickstart](https://stripe.com/
|
|
19
|
+
# Related guide: [Checkout quickstart](https://docs.stripe.com/checkout/quickstart)
|
|
20
20
|
class Session < APIResource
|
|
21
21
|
extend Stripe::APIOperations::Create
|
|
22
22
|
extend Stripe::APIOperations::List
|
|
@@ -177,7 +177,7 @@ module Stripe
|
|
|
177
177
|
attr_reader :line2
|
|
178
178
|
# ZIP or postal code.
|
|
179
179
|
attr_reader :postal_code
|
|
180
|
-
# State, county, province, or region.
|
|
180
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
181
181
|
attr_reader :state
|
|
182
182
|
|
|
183
183
|
def self.inner_class_types
|
|
@@ -501,7 +501,7 @@ module Stripe
|
|
|
501
501
|
attr_reader :line2
|
|
502
502
|
# ZIP or postal code.
|
|
503
503
|
attr_reader :postal_code
|
|
504
|
-
# State, county, province, or region.
|
|
504
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
505
505
|
attr_reader :state
|
|
506
506
|
|
|
507
507
|
def self.inner_class_types
|
|
@@ -625,7 +625,7 @@ module Stripe
|
|
|
625
625
|
attr_reader :footer
|
|
626
626
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
|
627
627
|
attr_reader :issuer
|
|
628
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
628
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
629
629
|
attr_reader :metadata
|
|
630
630
|
# Options for invoice PDF rendering.
|
|
631
631
|
attr_reader :rendering_options
|
|
@@ -1040,7 +1040,7 @@ module Stripe
|
|
|
1040
1040
|
attr_reader :request_multicapture
|
|
1041
1041
|
# Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
|
|
1042
1042
|
attr_reader :request_overcapture
|
|
1043
|
-
# 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/
|
|
1043
|
+
# 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
|
1044
1044
|
attr_reader :request_three_d_secure
|
|
1045
1045
|
# Attribute for field restrictions
|
|
1046
1046
|
attr_reader :restrictions
|
|
@@ -2119,10 +2119,10 @@ module Stripe
|
|
|
2119
2119
|
class Discount < ::Stripe::StripeObject
|
|
2120
2120
|
# The amount discounted.
|
|
2121
2121
|
attr_reader :amount
|
|
2122
|
-
# A discount represents the actual application of a [coupon](https://stripe.com
|
|
2122
|
+
# A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
|
|
2123
2123
|
# It contains information about when the discount began, when it will end, and what it is applied to.
|
|
2124
2124
|
#
|
|
2125
|
-
# Related guide: [Applying discounts to subscriptions](https://stripe.com/
|
|
2125
|
+
# Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
|
|
2126
2126
|
attr_reader :discount
|
|
2127
2127
|
|
|
2128
2128
|
def self.inner_class_types
|
|
@@ -2321,7 +2321,7 @@ module Stripe
|
|
|
2321
2321
|
# Session with your internal systems.
|
|
2322
2322
|
attr_reader :client_reference_id
|
|
2323
2323
|
# The client secret of your Checkout Session. Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. For `ui_mode: embedded`, the client secret is to be used when initializing Stripe.js embedded checkout.
|
|
2324
|
-
# For `ui_mode: custom`, use the client secret with [initCheckout](https://stripe.com/
|
|
2324
|
+
# For `ui_mode: custom`, use the client secret with [initCheckout](https://docs.stripe.com/js/custom_checkout/init) on your front end.
|
|
2325
2325
|
attr_reader :client_secret
|
|
2326
2326
|
# Information about the customer collected within the Checkout Session.
|
|
2327
2327
|
attr_reader :collected_information
|
|
@@ -2375,7 +2375,7 @@ module Stripe
|
|
|
2375
2375
|
attr_reader :livemode
|
|
2376
2376
|
# The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
|
|
2377
2377
|
attr_reader :locale
|
|
2378
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
2378
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
2379
2379
|
attr_reader :metadata
|
|
2380
2380
|
# The mode of the Checkout Session.
|
|
2381
2381
|
attr_reader :mode
|
|
@@ -2387,7 +2387,7 @@ module Stripe
|
|
|
2387
2387
|
attr_reader :optional_items
|
|
2388
2388
|
# Where the user is coming from. This informs the optimizations that are applied to the session.
|
|
2389
2389
|
attr_reader :origin_context
|
|
2390
|
-
# 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/
|
|
2390
|
+
# 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://docs.stripe.com/api/checkout/sessions/expire) instead.
|
|
2391
2391
|
attr_reader :payment_intent
|
|
2392
2392
|
# The ID of the Payment Link that created this Session.
|
|
2393
2393
|
attr_reader :payment_link
|
|
@@ -2413,13 +2413,13 @@ module Stripe
|
|
|
2413
2413
|
attr_reader :presentment_details
|
|
2414
2414
|
# The ID of the original expired Checkout Session that triggered the recovery flow.
|
|
2415
2415
|
attr_reader :recovered_from
|
|
2416
|
-
# This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/
|
|
2416
|
+
# This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
|
|
2417
2417
|
attr_reader :redirect_on_completion
|
|
2418
2418
|
# 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.
|
|
2419
2419
|
attr_reader :return_url
|
|
2420
2420
|
# Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
|
|
2421
2421
|
attr_reader :saved_payment_method_options
|
|
2422
|
-
# 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/
|
|
2422
|
+
# 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://docs.stripe.com/api/checkout/sessions/expire) instead.
|
|
2423
2423
|
attr_reader :setup_intent
|
|
2424
2424
|
# When set, provides configuration for Checkout to collect a shipping address from a customer.
|
|
2425
2425
|
attr_reader :shipping_address_collection
|
|
@@ -2433,7 +2433,7 @@ module Stripe
|
|
|
2433
2433
|
# relevant text on the page, such as the submit button. `submit_type` can only be
|
|
2434
2434
|
# specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
|
|
2435
2435
|
attr_reader :submit_type
|
|
2436
|
-
# The ID of the [Subscription](https://stripe.com/
|
|
2436
|
+
# The ID of the [Subscription](https://docs.stripe.com/api/subscriptions) for Checkout Sessions in `subscription` mode.
|
|
2437
2437
|
attr_reader :subscription
|
|
2438
2438
|
# The URL the customer will be directed to after the payment or
|
|
2439
2439
|
# subscription creation is successful.
|
|
@@ -2444,7 +2444,7 @@ module Stripe
|
|
|
2444
2444
|
attr_reader :total_details
|
|
2445
2445
|
# The UI mode of the Session. Defaults to `hosted`.
|
|
2446
2446
|
attr_reader :ui_mode
|
|
2447
|
-
# The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted`. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/
|
|
2447
|
+
# The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted`. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://docs.stripe.com/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`
|
|
2448
2448
|
# This value is only present when the session is active.
|
|
2449
2449
|
attr_reader :url
|
|
2450
2450
|
# Wallet-specific configuration for this Checkout Session.
|
|
@@ -100,7 +100,7 @@ module Stripe
|
|
|
100
100
|
attr_reader :id
|
|
101
101
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
102
102
|
attr_reader :livemode
|
|
103
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
103
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
104
104
|
attr_reader :metadata
|
|
105
105
|
# Quantity of carbon removal that is included in this order.
|
|
106
106
|
attr_reader :metric_tons
|
|
@@ -7,8 +7,8 @@ module Stripe
|
|
|
7
7
|
# is successful, values present on the ConfirmationToken are written onto the Intent.
|
|
8
8
|
#
|
|
9
9
|
# To learn more about how to use ConfirmationToken, visit the related guides:
|
|
10
|
-
# - [Finalize payments on the server](https://stripe.com/
|
|
11
|
-
# - [Build two-step confirmation](https://stripe.com/
|
|
10
|
+
# - [Finalize payments on the server](https://docs.stripe.com/payments/finalize-payments-on-the-server)
|
|
11
|
+
# - [Build two-step confirmation](https://docs.stripe.com/payments/build-a-two-step-confirmation).
|
|
12
12
|
class ConfirmationToken < APIResource
|
|
13
13
|
OBJECT_NAME = "confirmation_token"
|
|
14
14
|
def self.object_name
|
|
@@ -252,7 +252,7 @@ module Stripe
|
|
|
252
252
|
attr_reader :line2
|
|
253
253
|
# ZIP or postal code.
|
|
254
254
|
attr_reader :postal_code
|
|
255
|
-
# State, county, province, or region.
|
|
255
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
256
256
|
attr_reader :state
|
|
257
257
|
|
|
258
258
|
def self.inner_class_types
|
|
@@ -428,7 +428,7 @@ module Stripe
|
|
|
428
428
|
attr_reader :generated_card
|
|
429
429
|
# Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
|
|
430
430
|
attr_reader :iin
|
|
431
|
-
# Whether this [PaymentIntent](https://stripe.com/
|
|
431
|
+
# Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
|
|
432
432
|
attr_reader :incremental_authorization_supported
|
|
433
433
|
# The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
|
|
434
434
|
attr_reader :issuer
|
|
@@ -569,7 +569,7 @@ module Stripe
|
|
|
569
569
|
attr_reader :line2
|
|
570
570
|
# ZIP or postal code.
|
|
571
571
|
attr_reader :postal_code
|
|
572
|
-
# State, county, province, or region.
|
|
572
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
573
573
|
attr_reader :state
|
|
574
574
|
|
|
575
575
|
def self.inner_class_types
|
|
@@ -592,7 +592,7 @@ module Stripe
|
|
|
592
592
|
attr_reader :line2
|
|
593
593
|
# ZIP or postal code.
|
|
594
594
|
attr_reader :postal_code
|
|
595
|
-
# State, county, province, or region.
|
|
595
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
596
596
|
attr_reader :state
|
|
597
597
|
|
|
598
598
|
def self.inner_class_types
|
|
@@ -646,7 +646,7 @@ module Stripe
|
|
|
646
646
|
attr_reader :line2
|
|
647
647
|
# ZIP or postal code.
|
|
648
648
|
attr_reader :postal_code
|
|
649
|
-
# State, county, province, or region.
|
|
649
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
650
650
|
attr_reader :state
|
|
651
651
|
|
|
652
652
|
def self.inner_class_types
|
|
@@ -669,7 +669,7 @@ module Stripe
|
|
|
669
669
|
attr_reader :line2
|
|
670
670
|
# ZIP or postal code.
|
|
671
671
|
attr_reader :postal_code
|
|
672
|
-
# State, county, province, or region.
|
|
672
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
673
673
|
attr_reader :state
|
|
674
674
|
|
|
675
675
|
def self.inner_class_types
|
|
@@ -992,7 +992,7 @@ module Stripe
|
|
|
992
992
|
end
|
|
993
993
|
|
|
994
994
|
class Ideal < ::Stripe::StripeObject
|
|
995
|
-
# The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
|
|
995
|
+
# The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
|
|
996
996
|
attr_reader :bank
|
|
997
997
|
# The Bank Identifier Code of the customer's bank, if the bank was provided.
|
|
998
998
|
attr_reader :bic
|
|
@@ -1797,7 +1797,7 @@ module Stripe
|
|
|
1797
1797
|
attr_reader :line2
|
|
1798
1798
|
# ZIP or postal code.
|
|
1799
1799
|
attr_reader :postal_code
|
|
1800
|
-
# State, county, province, or region.
|
|
1800
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
1801
1801
|
attr_reader :state
|
|
1802
1802
|
|
|
1803
1803
|
def self.inner_class_types
|
|
@@ -1845,7 +1845,7 @@ module Stripe
|
|
|
1845
1845
|
attr_reader :return_url
|
|
1846
1846
|
# Indicates that you intend to make future payments with this ConfirmationToken's payment method.
|
|
1847
1847
|
#
|
|
1848
|
-
# The presence of this property will [attach the payment method](https://stripe.com/
|
|
1848
|
+
# The presence of this property will [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.
|
|
1849
1849
|
attr_reader :setup_future_usage
|
|
1850
1850
|
# ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
|
|
1851
1851
|
attr_reader :setup_intent
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
5
|
# A coupon contains information about a percent-off or amount-off discount you
|
|
6
|
-
# might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com
|
|
7
|
-
# [checkout sessions](https://stripe.com/
|
|
6
|
+
# might want to apply to a customer. Coupons may be applied to [subscriptions](https://api.stripe.com#subscriptions), [invoices](https://api.stripe.com#invoices),
|
|
7
|
+
# [checkout sessions](https://docs.stripe.com/api/checkout/sessions), [quotes](https://api.stripe.com#quotes), and more. Coupons do not work with conventional one-off [charges](https://api.stripe.com#create_charge) or [payment intents](https://docs.stripe.com/api/payment_intents).
|
|
8
8
|
class Coupon < APIResource
|
|
9
9
|
extend Stripe::APIOperations::Create
|
|
10
10
|
include Stripe::APIOperations::Delete
|
|
@@ -78,7 +78,7 @@ module Stripe
|
|
|
78
78
|
attr_reader :livemode
|
|
79
79
|
# Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
|
|
80
80
|
attr_reader :max_redemptions
|
|
81
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
81
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
82
82
|
attr_reader :metadata
|
|
83
83
|
# Name of the coupon displayed to customers on for instance invoices or receipts.
|
|
84
84
|
attr_reader :name
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
module Stripe
|
|
5
5
|
# Issue a credit note to adjust an invoice's amount after the invoice is finalized.
|
|
6
6
|
#
|
|
7
|
-
# Related guide: [Credit notes](https://stripe.com/
|
|
7
|
+
# Related guide: [Credit notes](https://docs.stripe.com/billing/invoices/credit-notes)
|
|
8
8
|
class CreditNote < APIResource
|
|
9
9
|
extend Stripe::APIOperations::Create
|
|
10
10
|
extend Stripe::APIOperations::List
|
|
@@ -125,7 +125,7 @@ module Stripe
|
|
|
125
125
|
|
|
126
126
|
class TotalTax < ::Stripe::StripeObject
|
|
127
127
|
class TaxRateDetails < ::Stripe::StripeObject
|
|
128
|
-
#
|
|
128
|
+
# ID of the tax rate
|
|
129
129
|
attr_reader :tax_rate
|
|
130
130
|
|
|
131
131
|
def self.inner_class_types
|
|
@@ -167,7 +167,7 @@ module Stripe
|
|
|
167
167
|
attr_reader :currency
|
|
168
168
|
# ID of the customer.
|
|
169
169
|
attr_reader :customer
|
|
170
|
-
# ID of the account.
|
|
170
|
+
# ID of the account representing the customer.
|
|
171
171
|
attr_reader :customer_account
|
|
172
172
|
# Customer balance transaction related to this credit note.
|
|
173
173
|
attr_reader :customer_balance_transaction
|
|
@@ -187,7 +187,7 @@ module Stripe
|
|
|
187
187
|
attr_reader :livemode
|
|
188
188
|
# Customer-facing text that appears on the credit note PDF.
|
|
189
189
|
attr_reader :memo
|
|
190
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
190
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
191
191
|
attr_reader :metadata
|
|
192
192
|
# A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
|
|
193
193
|
attr_reader :number
|
|
@@ -209,7 +209,7 @@ module Stripe
|
|
|
209
209
|
attr_reader :refunds
|
|
210
210
|
# The details of the cost of shipping, including the ShippingRate applied to the invoice.
|
|
211
211
|
attr_reader :shipping_cost
|
|
212
|
-
# Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/
|
|
212
|
+
# Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://docs.stripe.com/billing/invoices/credit-notes#voiding).
|
|
213
213
|
attr_reader :status
|
|
214
214
|
# The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
|
|
215
215
|
attr_reader :subtotal
|