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
|
@@ -408,7 +408,7 @@ module Stripe
|
|
|
408
408
|
attr_accessor :currency
|
|
409
409
|
# Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
|
|
410
410
|
attr_accessor :duration
|
|
411
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
411
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
412
412
|
attr_accessor :metadata
|
|
413
413
|
# Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
|
|
414
414
|
attr_accessor :name
|
|
@@ -433,7 +433,7 @@ module Stripe
|
|
|
433
433
|
end
|
|
434
434
|
# The ID of the coupon to apply to this Session.
|
|
435
435
|
attr_accessor :coupon
|
|
436
|
-
# Data used to generate a new [Coupon](https://stripe.com/
|
|
436
|
+
# Data used to generate a new [Coupon](https://docs.stripe.com/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
|
|
437
437
|
attr_accessor :coupon_data
|
|
438
438
|
# The ID of a promotion code to apply to this Session.
|
|
439
439
|
attr_accessor :promotion_code
|
|
@@ -492,7 +492,7 @@ module Stripe
|
|
|
492
492
|
attr_accessor :footer
|
|
493
493
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
|
494
494
|
attr_accessor :issuer
|
|
495
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
495
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
496
496
|
attr_accessor :metadata
|
|
497
497
|
# Default options for invoice PDF rendering for this customer.
|
|
498
498
|
attr_accessor :rendering_options
|
|
@@ -544,18 +544,28 @@ module Stripe
|
|
|
544
544
|
|
|
545
545
|
class PriceData < ::Stripe::RequestParams
|
|
546
546
|
class ProductData < ::Stripe::RequestParams
|
|
547
|
+
class TaxDetails < ::Stripe::RequestParams
|
|
548
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
549
|
+
attr_accessor :tax_code
|
|
550
|
+
|
|
551
|
+
def initialize(tax_code: nil)
|
|
552
|
+
@tax_code = tax_code
|
|
553
|
+
end
|
|
554
|
+
end
|
|
547
555
|
# 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.
|
|
548
556
|
attr_accessor :description
|
|
549
557
|
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
|
550
558
|
attr_accessor :images
|
|
551
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
559
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
552
560
|
attr_accessor :metadata
|
|
553
561
|
# The product's name, meant to be displayable to the customer.
|
|
554
562
|
attr_accessor :name
|
|
555
|
-
# A [tax code](https://stripe.com/
|
|
563
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
556
564
|
attr_accessor :tax_code
|
|
557
565
|
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
558
566
|
attr_accessor :unit_label
|
|
567
|
+
# Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.
|
|
568
|
+
attr_accessor :tax_details
|
|
559
569
|
|
|
560
570
|
def initialize(
|
|
561
571
|
description: nil,
|
|
@@ -563,7 +573,8 @@ module Stripe
|
|
|
563
573
|
metadata: nil,
|
|
564
574
|
name: nil,
|
|
565
575
|
tax_code: nil,
|
|
566
|
-
unit_label: nil
|
|
576
|
+
unit_label: nil,
|
|
577
|
+
tax_details: nil
|
|
567
578
|
)
|
|
568
579
|
@description = description
|
|
569
580
|
@images = images
|
|
@@ -571,6 +582,7 @@ module Stripe
|
|
|
571
582
|
@name = name
|
|
572
583
|
@tax_code = tax_code
|
|
573
584
|
@unit_label = unit_label
|
|
585
|
+
@tax_details = tax_details
|
|
574
586
|
end
|
|
575
587
|
end
|
|
576
588
|
|
|
@@ -593,7 +605,7 @@ module Stripe
|
|
|
593
605
|
attr_accessor :product_data
|
|
594
606
|
# The recurring components of a price such as `interval` and `interval_count`.
|
|
595
607
|
attr_accessor :recurring
|
|
596
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
608
|
+
# Only required if a [default tax behavior](https://docs.stripe.com/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.
|
|
597
609
|
attr_accessor :tax_behavior
|
|
598
610
|
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
|
|
599
611
|
attr_accessor :unit_amount
|
|
@@ -620,17 +632,17 @@ module Stripe
|
|
|
620
632
|
end
|
|
621
633
|
# When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
|
|
622
634
|
attr_accessor :adjustable_quantity
|
|
623
|
-
# The [tax rates](https://stripe.com/
|
|
635
|
+
# The [tax rates](https://docs.stripe.com/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.
|
|
624
636
|
attr_accessor :dynamic_tax_rates
|
|
625
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
637
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
626
638
|
attr_accessor :metadata
|
|
627
|
-
# The ID of the [Price](https://stripe.com/
|
|
639
|
+
# The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object. One of `price` or `price_data` is required.
|
|
628
640
|
attr_accessor :price
|
|
629
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
641
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
630
642
|
attr_accessor :price_data
|
|
631
643
|
# The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
|
|
632
644
|
attr_accessor :quantity
|
|
633
|
-
# The [tax rates](https://stripe.com/
|
|
645
|
+
# The [tax rates](https://docs.stripe.com/api/tax_rates) which apply to this line item.
|
|
634
646
|
attr_accessor :tax_rates
|
|
635
647
|
|
|
636
648
|
def initialize(
|
|
@@ -704,7 +716,7 @@ module Stripe
|
|
|
704
716
|
end
|
|
705
717
|
# When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.
|
|
706
718
|
attr_accessor :adjustable_quantity
|
|
707
|
-
# The ID of the [Price](https://stripe.com/
|
|
719
|
+
# The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object.
|
|
708
720
|
attr_accessor :price
|
|
709
721
|
# The initial quantity of the line item created when a customer chooses to add this optional item to their order.
|
|
710
722
|
attr_accessor :quantity
|
|
@@ -729,7 +741,7 @@ module Stripe
|
|
|
729
741
|
attr_accessor :line2
|
|
730
742
|
# ZIP or postal code.
|
|
731
743
|
attr_accessor :postal_code
|
|
732
|
-
# State, county, province, or region.
|
|
744
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
733
745
|
attr_accessor :state
|
|
734
746
|
|
|
735
747
|
def initialize(
|
|
@@ -782,13 +794,13 @@ module Stripe
|
|
|
782
794
|
@destination = destination
|
|
783
795
|
end
|
|
784
796
|
end
|
|
785
|
-
# 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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/
|
|
797
|
+
# 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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts).
|
|
786
798
|
attr_accessor :application_fee_amount
|
|
787
799
|
# Controls when the funds will be captured from the customer's account.
|
|
788
800
|
attr_accessor :capture_method
|
|
789
801
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
|
790
802
|
attr_accessor :description
|
|
791
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
803
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
792
804
|
attr_accessor :metadata
|
|
793
805
|
# The Stripe account ID for which these funds are intended. For details,
|
|
794
806
|
# see the PaymentIntents [use case for connected
|
|
@@ -796,7 +808,7 @@ module Stripe
|
|
|
796
808
|
attr_accessor :on_behalf_of
|
|
797
809
|
# 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).
|
|
798
810
|
attr_accessor :receipt_email
|
|
799
|
-
# Indicates that you intend to [make future payments](https://stripe.com/
|
|
811
|
+
# Indicates that you intend to [make future payments](https://docs.stripe.com/payments/payment-intents#future-usage) with the payment
|
|
800
812
|
# method collected by this Checkout Session.
|
|
801
813
|
#
|
|
802
814
|
# When setting this to `on_session`, Checkout will show a notice to the
|
|
@@ -826,9 +838,9 @@ module Stripe
|
|
|
826
838
|
# 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.
|
|
827
839
|
attr_accessor :statement_descriptor_suffix
|
|
828
840
|
# The parameters used to automatically create a Transfer when the payment succeeds.
|
|
829
|
-
# For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/
|
|
841
|
+
# For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts).
|
|
830
842
|
attr_accessor :transfer_data
|
|
831
|
-
# A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/
|
|
843
|
+
# A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details.
|
|
832
844
|
attr_accessor :transfer_group
|
|
833
845
|
|
|
834
846
|
def initialize(
|
|
@@ -1131,7 +1143,7 @@ module Stripe
|
|
|
1131
1143
|
attr_accessor :request_multicapture
|
|
1132
1144
|
# Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
|
|
1133
1145
|
attr_accessor :request_overcapture
|
|
1134
|
-
# 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/
|
|
1146
|
+
# 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.
|
|
1135
1147
|
attr_accessor :request_three_d_secure
|
|
1136
1148
|
# Restrictions to apply to the card payment method. For example, you can block specific card brands.
|
|
1137
1149
|
attr_accessor :restrictions
|
|
@@ -1576,7 +1588,7 @@ module Stripe
|
|
|
1576
1588
|
class Paypal < ::Stripe::RequestParams
|
|
1577
1589
|
# Controls when the funds will be captured from the customer's account.
|
|
1578
1590
|
attr_accessor :capture_method
|
|
1579
|
-
# [Preferred locale](https://stripe.com/
|
|
1591
|
+
# [Preferred locale](https://docs.stripe.com/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
|
|
1580
1592
|
attr_accessor :preferred_locale
|
|
1581
1593
|
# 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.
|
|
1582
1594
|
attr_accessor :reference
|
|
@@ -2170,7 +2182,7 @@ module Stripe
|
|
|
2170
2182
|
class SetupIntentData < ::Stripe::RequestParams
|
|
2171
2183
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
|
2172
2184
|
attr_accessor :description
|
|
2173
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
2185
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
2174
2186
|
attr_accessor :metadata
|
|
2175
2187
|
# The Stripe account for which the setup is intended.
|
|
2176
2188
|
attr_accessor :on_behalf_of
|
|
@@ -2260,11 +2272,11 @@ module Stripe
|
|
|
2260
2272
|
attr_accessor :display_name
|
|
2261
2273
|
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
|
|
2262
2274
|
attr_accessor :fixed_amount
|
|
2263
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
2275
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
2264
2276
|
attr_accessor :metadata
|
|
2265
2277
|
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
|
2266
2278
|
attr_accessor :tax_behavior
|
|
2267
|
-
# A [tax code](https://stripe.com/
|
|
2279
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
|
|
2268
2280
|
attr_accessor :tax_code
|
|
2269
2281
|
# The type of calculation to use on the shipping rate.
|
|
2270
2282
|
attr_accessor :type
|
|
@@ -2379,11 +2391,11 @@ module Stripe
|
|
|
2379
2391
|
attr_accessor :default_tax_rates
|
|
2380
2392
|
# The subscription's description, meant to be displayable to the customer.
|
|
2381
2393
|
# Use this field to optionally store an explanation of the subscription
|
|
2382
|
-
# for rendering in the [customer portal](https://stripe.com/
|
|
2394
|
+
# for rendering in the [customer portal](https://docs.stripe.com/customer-management).
|
|
2383
2395
|
attr_accessor :description
|
|
2384
2396
|
# All invoices will be billed using the specified settings.
|
|
2385
2397
|
attr_accessor :invoice_settings
|
|
2386
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
2398
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
2387
2399
|
attr_accessor :metadata
|
|
2388
2400
|
# The account on behalf of which to charge, for each of the subscription's invoices.
|
|
2389
2401
|
attr_accessor :on_behalf_of
|
|
@@ -2485,24 +2497,24 @@ module Stripe
|
|
|
2485
2497
|
attr_accessor :custom_text
|
|
2486
2498
|
# ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
|
|
2487
2499
|
# payment method will be used to prefill the email, name, card details, and billing address
|
|
2488
|
-
# on the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/
|
|
2500
|
+
# on the Checkout page. In `subscription` mode, the customer’s [default payment method](https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method)
|
|
2489
2501
|
# will be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.
|
|
2490
2502
|
#
|
|
2491
|
-
# If the Customer already has a valid [email](https://stripe.com/
|
|
2503
|
+
# If the Customer already has a valid [email](https://docs.stripe.com/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.
|
|
2492
2504
|
# If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
|
|
2493
2505
|
#
|
|
2494
2506
|
# If blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.
|
|
2495
2507
|
#
|
|
2496
|
-
# You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/
|
|
2508
|
+
# You can set [`payment_intent_data.setup_future_usage`](https://docs.stripe.com/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.
|
|
2497
2509
|
attr_accessor :customer
|
|
2498
2510
|
# ID of an existing Account, if one exists. Has the same behavior as `customer`.
|
|
2499
2511
|
attr_accessor :customer_account
|
|
2500
|
-
# Configure whether a Checkout Session creates a [Customer](https://stripe.com/
|
|
2512
|
+
# Configure whether a Checkout Session creates a [Customer](https://docs.stripe.com/api/customers) during Session confirmation.
|
|
2501
2513
|
#
|
|
2502
2514
|
# When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
|
|
2503
|
-
# with [customer_details](https://stripe.com/
|
|
2515
|
+
# with [customer_details](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-customer_details).
|
|
2504
2516
|
#
|
|
2505
|
-
# Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/
|
|
2517
|
+
# Sessions that don't create Customers instead are grouped by [guest customers](https://docs.stripe.com/payments/checkout/guest-customers)
|
|
2506
2518
|
# in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
|
|
2507
2519
|
#
|
|
2508
2520
|
# Can only be set in `payment` and `setup` mode.
|
|
@@ -2525,7 +2537,7 @@ module Stripe
|
|
|
2525
2537
|
attr_accessor :expires_at
|
|
2526
2538
|
# Generate a post-purchase Invoice for one-time payments.
|
|
2527
2539
|
attr_accessor :invoice_creation
|
|
2528
|
-
# A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/
|
|
2540
|
+
# A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). The parameter is required for `payment` and `subscription` mode.
|
|
2529
2541
|
#
|
|
2530
2542
|
# 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.
|
|
2531
2543
|
#
|
|
@@ -2533,7 +2545,7 @@ module Stripe
|
|
|
2533
2545
|
attr_accessor :line_items
|
|
2534
2546
|
# The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
|
|
2535
2547
|
attr_accessor :locale
|
|
2536
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
2548
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
2537
2549
|
attr_accessor :metadata
|
|
2538
2550
|
# The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
|
|
2539
2551
|
attr_accessor :mode
|
|
@@ -2541,9 +2553,9 @@ module Stripe
|
|
|
2541
2553
|
#
|
|
2542
2554
|
# You can configure Checkout to collect your customers' business names, individual names, or both. Each name field can be either required or optional.
|
|
2543
2555
|
#
|
|
2544
|
-
# If a [Customer](https://stripe.com/
|
|
2556
|
+
# If a [Customer](https://docs.stripe.com/api/customers) is created or provided, the names can be saved to the Customer object as well.
|
|
2545
2557
|
attr_accessor :name_collection
|
|
2546
|
-
# A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/
|
|
2558
|
+
# A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices).
|
|
2547
2559
|
#
|
|
2548
2560
|
# There is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items.
|
|
2549
2561
|
#
|
|
@@ -2560,7 +2572,7 @@ module Stripe
|
|
|
2560
2572
|
#
|
|
2561
2573
|
# Can only be set in `subscription` mode. Defaults to `always`.
|
|
2562
2574
|
#
|
|
2563
|
-
# 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/
|
|
2575
|
+
# 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://docs.stripe.com/payments/checkout/free-trials).
|
|
2564
2576
|
attr_accessor :payment_method_collection
|
|
2565
2577
|
# The ID of the payment method configuration to use with this Checkout session.
|
|
2566
2578
|
attr_accessor :payment_method_configuration
|
|
@@ -2571,7 +2583,7 @@ module Stripe
|
|
|
2571
2583
|
# A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
|
|
2572
2584
|
#
|
|
2573
2585
|
# You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
|
|
2574
|
-
# See [Dynamic Payment Methods](https://stripe.com/
|
|
2586
|
+
# See [Dynamic Payment Methods](https://docs.stripe.com/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.
|
|
2575
2587
|
#
|
|
2576
2588
|
# Read more about the supported payment methods and their requirements in our [payment
|
|
2577
2589
|
# method details guide](/docs/payments/checkout/payment-methods).
|
|
@@ -2587,9 +2599,9 @@ module Stripe
|
|
|
2587
2599
|
# Controls phone number collection settings for the session.
|
|
2588
2600
|
#
|
|
2589
2601
|
# We recommend that you review your privacy policy and check with your legal contacts
|
|
2590
|
-
# before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/
|
|
2602
|
+
# before using this feature. Learn more about [collecting phone numbers with Checkout](https://docs.stripe.com/payments/checkout/phone-numbers).
|
|
2591
2603
|
attr_accessor :phone_number_collection
|
|
2592
|
-
# This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/
|
|
2604
|
+
# 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`.
|
|
2593
2605
|
attr_accessor :redirect_on_completion
|
|
2594
2606
|
# The URL to redirect your customer back to after they authenticate or cancel their payment on the
|
|
2595
2607
|
# payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
|
|
@@ -2614,7 +2626,7 @@ module Stripe
|
|
|
2614
2626
|
# is complete.
|
|
2615
2627
|
# This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
|
|
2616
2628
|
# information from the successful Checkout Session on your page, read the
|
|
2617
|
-
# guide on [customizing your success page](https://stripe.com/
|
|
2629
|
+
# guide on [customizing your success page](https://docs.stripe.com/payments/checkout/custom-success-page).
|
|
2618
2630
|
attr_accessor :success_url
|
|
2619
2631
|
# Controls tax ID collection during checkout.
|
|
2620
2632
|
attr_accessor :tax_id_collection
|
|
@@ -37,7 +37,7 @@ module Stripe
|
|
|
37
37
|
attr_accessor :line2
|
|
38
38
|
# ZIP or postal code.
|
|
39
39
|
attr_accessor :postal_code
|
|
40
|
-
# State, county, province, or region.
|
|
40
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
41
41
|
attr_accessor :state
|
|
42
42
|
|
|
43
43
|
def initialize(
|
|
@@ -82,7 +82,7 @@ module Stripe
|
|
|
82
82
|
attr_accessor :currency
|
|
83
83
|
# Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
|
|
84
84
|
attr_accessor :duration
|
|
85
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
85
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
86
86
|
attr_accessor :metadata
|
|
87
87
|
# Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
|
|
88
88
|
attr_accessor :name
|
|
@@ -105,9 +105,9 @@ module Stripe
|
|
|
105
105
|
@percent_off = percent_off
|
|
106
106
|
end
|
|
107
107
|
end
|
|
108
|
-
# The ID of the [Coupon](https://stripe.com/
|
|
108
|
+
# The ID of the [Coupon](https://docs.stripe.com/api/coupons) to apply to this Session. One of `coupon` or `coupon_data` is required when updating discounts.
|
|
109
109
|
attr_accessor :coupon
|
|
110
|
-
# Data used to generate a new [Coupon](https://stripe.com/
|
|
110
|
+
# Data used to generate a new [Coupon](https://docs.stripe.com/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
|
|
111
111
|
attr_accessor :coupon_data
|
|
112
112
|
|
|
113
113
|
def initialize(coupon: nil, coupon_data: nil)
|
|
@@ -162,18 +162,28 @@ module Stripe
|
|
|
162
162
|
|
|
163
163
|
class PriceData < ::Stripe::RequestParams
|
|
164
164
|
class ProductData < ::Stripe::RequestParams
|
|
165
|
+
class TaxDetails < ::Stripe::RequestParams
|
|
166
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
167
|
+
attr_accessor :tax_code
|
|
168
|
+
|
|
169
|
+
def initialize(tax_code: nil)
|
|
170
|
+
@tax_code = tax_code
|
|
171
|
+
end
|
|
172
|
+
end
|
|
165
173
|
# 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.
|
|
166
174
|
attr_accessor :description
|
|
167
175
|
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
|
168
176
|
attr_accessor :images
|
|
169
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
177
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
170
178
|
attr_accessor :metadata
|
|
171
179
|
# The product's name, meant to be displayable to the customer.
|
|
172
180
|
attr_accessor :name
|
|
173
|
-
# A [tax code](https://stripe.com/
|
|
181
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
174
182
|
attr_accessor :tax_code
|
|
175
183
|
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
176
184
|
attr_accessor :unit_label
|
|
185
|
+
# Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.
|
|
186
|
+
attr_accessor :tax_details
|
|
177
187
|
|
|
178
188
|
def initialize(
|
|
179
189
|
description: nil,
|
|
@@ -181,7 +191,8 @@ module Stripe
|
|
|
181
191
|
metadata: nil,
|
|
182
192
|
name: nil,
|
|
183
193
|
tax_code: nil,
|
|
184
|
-
unit_label: nil
|
|
194
|
+
unit_label: nil,
|
|
195
|
+
tax_details: nil
|
|
185
196
|
)
|
|
186
197
|
@description = description
|
|
187
198
|
@images = images
|
|
@@ -189,6 +200,7 @@ module Stripe
|
|
|
189
200
|
@name = name
|
|
190
201
|
@tax_code = tax_code
|
|
191
202
|
@unit_label = unit_label
|
|
203
|
+
@tax_details = tax_details
|
|
192
204
|
end
|
|
193
205
|
end
|
|
194
206
|
|
|
@@ -211,7 +223,7 @@ module Stripe
|
|
|
211
223
|
attr_accessor :product_data
|
|
212
224
|
# The recurring components of a price such as `interval` and `interval_count`.
|
|
213
225
|
attr_accessor :recurring
|
|
214
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
226
|
+
# Only required if a [default tax behavior](https://docs.stripe.com/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.
|
|
215
227
|
attr_accessor :tax_behavior
|
|
216
228
|
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
|
|
217
229
|
attr_accessor :unit_amount
|
|
@@ -240,15 +252,15 @@ module Stripe
|
|
|
240
252
|
attr_accessor :adjustable_quantity
|
|
241
253
|
# ID of an existing line item.
|
|
242
254
|
attr_accessor :id
|
|
243
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
255
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
244
256
|
attr_accessor :metadata
|
|
245
|
-
# The ID of the [Price](https://stripe.com/
|
|
257
|
+
# The ID of the [Price](https://docs.stripe.com/api/prices). One of `price` or `price_data` is required when creating a new line item.
|
|
246
258
|
attr_accessor :price
|
|
247
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
259
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required when creating a new line item.
|
|
248
260
|
attr_accessor :price_data
|
|
249
261
|
# The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
|
|
250
262
|
attr_accessor :quantity
|
|
251
|
-
# The [tax rates](https://stripe.com/
|
|
263
|
+
# The [tax rates](https://docs.stripe.com/api/tax_rates) which apply to this line item.
|
|
252
264
|
attr_accessor :tax_rates
|
|
253
265
|
|
|
254
266
|
def initialize(
|
|
@@ -338,11 +350,11 @@ module Stripe
|
|
|
338
350
|
attr_accessor :display_name
|
|
339
351
|
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
|
|
340
352
|
attr_accessor :fixed_amount
|
|
341
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
353
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
342
354
|
attr_accessor :metadata
|
|
343
355
|
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
|
344
356
|
attr_accessor :tax_behavior
|
|
345
|
-
# A [tax code](https://stripe.com/
|
|
357
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
|
|
346
358
|
attr_accessor :tax_code
|
|
347
359
|
# The type of calculation to use on the shipping rate.
|
|
348
360
|
attr_accessor :type
|
|
@@ -433,7 +445,7 @@ module Stripe
|
|
|
433
445
|
#
|
|
434
446
|
# To reorder a line item, specify it at the desired position in the retransmitted array.
|
|
435
447
|
attr_accessor :line_items
|
|
436
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
448
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
437
449
|
attr_accessor :metadata
|
|
438
450
|
# The shipping rate options to apply to this Session. Up to a maximum of 5.
|
|
439
451
|
attr_accessor :shipping_options
|
|
@@ -20,7 +20,7 @@ module Stripe
|
|
|
20
20
|
attr_accessor :currency
|
|
21
21
|
# Specifies which fields in the response should be expanded.
|
|
22
22
|
attr_accessor :expand
|
|
23
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
23
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
24
24
|
attr_accessor :metadata
|
|
25
25
|
# Requested number of tons for the order. Either this or `amount` must be specified.
|
|
26
26
|
attr_accessor :metric_tons
|
|
@@ -16,7 +16,7 @@ module Stripe
|
|
|
16
16
|
attr_accessor :beneficiary
|
|
17
17
|
# Specifies which fields in the response should be expanded.
|
|
18
18
|
attr_accessor :expand
|
|
19
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
19
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
20
20
|
attr_accessor :metadata
|
|
21
21
|
|
|
22
22
|
def initialize(beneficiary: nil, expand: nil, metadata: nil)
|
|
@@ -64,7 +64,7 @@ module Stripe
|
|
|
64
64
|
attr_accessor :line2
|
|
65
65
|
# ZIP or postal code.
|
|
66
66
|
attr_accessor :postal_code
|
|
67
|
-
# State, county, province, or region.
|
|
67
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
68
68
|
attr_accessor :state
|
|
69
69
|
|
|
70
70
|
def initialize(
|
|
@@ -271,7 +271,7 @@ module Stripe
|
|
|
271
271
|
class Qris < ::Stripe::RequestParams; end
|
|
272
272
|
|
|
273
273
|
class RadarOptions < ::Stripe::RequestParams
|
|
274
|
-
# A [Radar Session](https://stripe.com/
|
|
274
|
+
# 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.
|
|
275
275
|
attr_accessor :session
|
|
276
276
|
|
|
277
277
|
def initialize(session: nil)
|
|
@@ -432,7 +432,7 @@ module Stripe
|
|
|
432
432
|
attr_accessor :link
|
|
433
433
|
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
|
|
434
434
|
attr_accessor :mb_way
|
|
435
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
435
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
436
436
|
attr_accessor :metadata
|
|
437
437
|
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
|
|
438
438
|
attr_accessor :mobilepay
|
|
@@ -464,7 +464,7 @@ module Stripe
|
|
|
464
464
|
attr_accessor :promptpay
|
|
465
465
|
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
|
|
466
466
|
attr_accessor :qris
|
|
467
|
-
# Options to configure Radar. See [Radar Session](https://stripe.com/
|
|
467
|
+
# Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.
|
|
468
468
|
attr_accessor :radar_options
|
|
469
469
|
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
|
|
470
470
|
attr_accessor :rechnung
|
|
@@ -677,7 +677,7 @@ module Stripe
|
|
|
677
677
|
attr_accessor :line2
|
|
678
678
|
# ZIP or postal code.
|
|
679
679
|
attr_accessor :postal_code
|
|
680
|
-
# State, county, province, or region.
|
|
680
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
681
681
|
attr_accessor :state
|
|
682
682
|
|
|
683
683
|
def initialize(
|
|
@@ -721,7 +721,7 @@ module Stripe
|
|
|
721
721
|
attr_accessor :return_url
|
|
722
722
|
# Indicates that you intend to make future payments with this ConfirmationToken's payment method.
|
|
723
723
|
#
|
|
724
|
-
# The presence of this property will [attach the payment method](https://stripe.com/
|
|
724
|
+
# 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.
|
|
725
725
|
attr_accessor :setup_future_usage
|
|
726
726
|
# Shipping information for this ConfirmationToken.
|
|
727
727
|
attr_accessor :shipping
|
|
@@ -50,7 +50,7 @@ module Stripe
|
|
|
50
50
|
attr_accessor :id
|
|
51
51
|
# A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.
|
|
52
52
|
attr_accessor :max_redemptions
|
|
53
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
53
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
54
54
|
attr_accessor :metadata
|
|
55
55
|
# Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
|
|
56
56
|
attr_accessor :name
|
|
@@ -15,7 +15,7 @@ module Stripe
|
|
|
15
15
|
attr_accessor :currency_options
|
|
16
16
|
# Specifies which fields in the response should be expanded.
|
|
17
17
|
attr_accessor :expand
|
|
18
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
18
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
19
19
|
attr_accessor :metadata
|
|
20
20
|
# Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
|
|
21
21
|
attr_accessor :name
|
|
@@ -113,7 +113,7 @@ module Stripe
|
|
|
113
113
|
attr_accessor :lines
|
|
114
114
|
# The credit note's memo appears on the credit note PDF.
|
|
115
115
|
attr_accessor :memo
|
|
116
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
116
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
117
117
|
attr_accessor :metadata
|
|
118
118
|
# The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
|
|
119
119
|
attr_accessor :out_of_band_amount
|
|
@@ -24,7 +24,7 @@ module Stripe
|
|
|
24
24
|
attr_accessor :created
|
|
25
25
|
# Only return credit notes for the customer specified by this customer ID.
|
|
26
26
|
attr_accessor :customer
|
|
27
|
-
# Only return credit notes for the account specified by this account ID.
|
|
27
|
+
# Only return credit notes for the account representing the customer specified by this account ID.
|
|
28
28
|
attr_accessor :customer_account
|
|
29
29
|
# 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.
|
|
30
30
|
attr_accessor :ending_before
|
|
@@ -117,7 +117,7 @@ module Stripe
|
|
|
117
117
|
attr_accessor :lines
|
|
118
118
|
# The credit note's memo appears on the credit note PDF.
|
|
119
119
|
attr_accessor :memo
|
|
120
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
120
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
121
121
|
attr_accessor :metadata
|
|
122
122
|
# The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
|
|
123
123
|
attr_accessor :out_of_band_amount
|
|
@@ -117,7 +117,7 @@ module Stripe
|
|
|
117
117
|
attr_accessor :lines
|
|
118
118
|
# The credit note's memo appears on the credit note PDF.
|
|
119
119
|
attr_accessor :memo
|
|
120
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
120
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
121
121
|
attr_accessor :metadata
|
|
122
122
|
# The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
|
|
123
123
|
attr_accessor :out_of_band_amount
|
|
@@ -113,7 +113,7 @@ module Stripe
|
|
|
113
113
|
attr_accessor :lines
|
|
114
114
|
# The credit note's memo appears on the credit note PDF.
|
|
115
115
|
attr_accessor :memo
|
|
116
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
116
|
+
# 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
117
117
|
attr_accessor :metadata
|
|
118
118
|
# The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
|
|
119
119
|
attr_accessor :out_of_band_amount
|