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
|
@@ -88,7 +88,7 @@ module Stripe
|
|
|
88
88
|
end
|
|
89
89
|
|
|
90
90
|
class Tax < ::Stripe::RequestParams
|
|
91
|
-
# The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/
|
|
91
|
+
# The total amount of tax on a single line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0.
|
|
92
92
|
#
|
|
93
93
|
# This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field.
|
|
94
94
|
attr_accessor :total_tax_amount
|
|
@@ -97,7 +97,7 @@ module Stripe
|
|
|
97
97
|
@total_tax_amount = total_tax_amount
|
|
98
98
|
end
|
|
99
99
|
end
|
|
100
|
-
# The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/
|
|
100
|
+
# The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.
|
|
101
101
|
#
|
|
102
102
|
# This field is mutually exclusive with the `amount_details[discount_amount]` field.
|
|
103
103
|
attr_accessor :discount_amount
|
|
@@ -113,7 +113,7 @@ module Stripe
|
|
|
113
113
|
attr_accessor :quantity
|
|
114
114
|
# Contains information about the tax on the item.
|
|
115
115
|
attr_accessor :tax
|
|
116
|
-
# The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/
|
|
116
|
+
# The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0.
|
|
117
117
|
attr_accessor :unit_cost
|
|
118
118
|
# A unit of measure for the line item, such as gallons, feet, meters, etc.
|
|
119
119
|
attr_accessor :unit_of_measure
|
|
@@ -140,7 +140,7 @@ module Stripe
|
|
|
140
140
|
end
|
|
141
141
|
|
|
142
142
|
class Shipping < ::Stripe::RequestParams
|
|
143
|
-
# If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/
|
|
143
|
+
# If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0.
|
|
144
144
|
attr_accessor :amount
|
|
145
145
|
# If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed.
|
|
146
146
|
attr_accessor :from_postal_code
|
|
@@ -155,7 +155,7 @@ module Stripe
|
|
|
155
155
|
end
|
|
156
156
|
|
|
157
157
|
class Tax < ::Stripe::RequestParams
|
|
158
|
-
# The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/
|
|
158
|
+
# The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.
|
|
159
159
|
#
|
|
160
160
|
# This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field.
|
|
161
161
|
attr_accessor :total_tax_amount
|
|
@@ -164,7 +164,7 @@ module Stripe
|
|
|
164
164
|
@total_tax_amount = total_tax_amount
|
|
165
165
|
end
|
|
166
166
|
end
|
|
167
|
-
# The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/
|
|
167
|
+
# The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.
|
|
168
168
|
#
|
|
169
169
|
# This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field.
|
|
170
170
|
attr_accessor :discount_amount
|
|
@@ -186,7 +186,7 @@ module Stripe
|
|
|
186
186
|
class Hooks < ::Stripe::RequestParams
|
|
187
187
|
class Inputs < ::Stripe::RequestParams
|
|
188
188
|
class Tax < ::Stripe::RequestParams
|
|
189
|
-
# The [TaxCalculation](https://stripe.com/
|
|
189
|
+
# The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) id
|
|
190
190
|
attr_accessor :calculation
|
|
191
191
|
|
|
192
192
|
def initialize(calculation: nil)
|
|
@@ -331,7 +331,7 @@ module Stripe
|
|
|
331
331
|
attr_accessor :line2
|
|
332
332
|
# ZIP or postal code.
|
|
333
333
|
attr_accessor :postal_code
|
|
334
|
-
# State, county, province, or region.
|
|
334
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
335
335
|
attr_accessor :state
|
|
336
336
|
|
|
337
337
|
def initialize(
|
|
@@ -362,7 +362,7 @@ module Stripe
|
|
|
362
362
|
attr_accessor :line2
|
|
363
363
|
# ZIP or postal code.
|
|
364
364
|
attr_accessor :postal_code
|
|
365
|
-
# State, county, province, or region.
|
|
365
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
366
366
|
attr_accessor :state
|
|
367
367
|
|
|
368
368
|
def initialize(
|
|
@@ -557,7 +557,7 @@ module Stripe
|
|
|
557
557
|
attr_accessor :line2
|
|
558
558
|
# ZIP or postal code.
|
|
559
559
|
attr_accessor :postal_code
|
|
560
|
-
# State, county, province, or region.
|
|
560
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
561
561
|
attr_accessor :state
|
|
562
562
|
|
|
563
563
|
def initialize(
|
|
@@ -625,7 +625,7 @@ module Stripe
|
|
|
625
625
|
attr_accessor :line2
|
|
626
626
|
# ZIP or postal code.
|
|
627
627
|
attr_accessor :postal_code
|
|
628
|
-
# State, county, province, or region.
|
|
628
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
629
629
|
attr_accessor :state
|
|
630
630
|
|
|
631
631
|
def initialize(
|
|
@@ -853,7 +853,7 @@ module Stripe
|
|
|
853
853
|
attr_accessor :line2
|
|
854
854
|
# ZIP or postal code.
|
|
855
855
|
attr_accessor :postal_code
|
|
856
|
-
# State, county, province, or region.
|
|
856
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
857
857
|
attr_accessor :state
|
|
858
858
|
|
|
859
859
|
def initialize(
|
|
@@ -1351,7 +1351,7 @@ module Stripe
|
|
|
1351
1351
|
attr_accessor :line2
|
|
1352
1352
|
# ZIP or postal code.
|
|
1353
1353
|
attr_accessor :postal_code
|
|
1354
|
-
# State, county, province, or region.
|
|
1354
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
1355
1355
|
attr_accessor :state
|
|
1356
1356
|
|
|
1357
1357
|
def initialize(
|
|
@@ -1573,7 +1573,7 @@ module Stripe
|
|
|
1573
1573
|
attr_accessor :line2
|
|
1574
1574
|
# ZIP or postal code.
|
|
1575
1575
|
attr_accessor :postal_code
|
|
1576
|
-
# State, county, province, or region.
|
|
1576
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
1577
1577
|
attr_accessor :state
|
|
1578
1578
|
|
|
1579
1579
|
def initialize(
|
|
@@ -1965,7 +1965,7 @@ module Stripe
|
|
|
1965
1965
|
attr_accessor :line2
|
|
1966
1966
|
# ZIP or postal code.
|
|
1967
1967
|
attr_accessor :postal_code
|
|
1968
|
-
# State, county, province, or region.
|
|
1968
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
1969
1969
|
attr_accessor :state
|
|
1970
1970
|
|
|
1971
1971
|
def initialize(
|
|
@@ -2172,7 +2172,7 @@ module Stripe
|
|
|
2172
2172
|
class Qris < ::Stripe::RequestParams; end
|
|
2173
2173
|
|
|
2174
2174
|
class RadarOptions < ::Stripe::RequestParams
|
|
2175
|
-
# A [Radar Session](https://stripe.com/
|
|
2175
|
+
# 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.
|
|
2176
2176
|
attr_accessor :session
|
|
2177
2177
|
|
|
2178
2178
|
def initialize(session: nil)
|
|
@@ -2333,7 +2333,7 @@ module Stripe
|
|
|
2333
2333
|
attr_accessor :link
|
|
2334
2334
|
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
|
|
2335
2335
|
attr_accessor :mb_way
|
|
2336
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
2336
|
+
# 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`.
|
|
2337
2337
|
attr_accessor :metadata
|
|
2338
2338
|
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
|
|
2339
2339
|
attr_accessor :mobilepay
|
|
@@ -2365,7 +2365,7 @@ module Stripe
|
|
|
2365
2365
|
attr_accessor :promptpay
|
|
2366
2366
|
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
|
|
2367
2367
|
attr_accessor :qris
|
|
2368
|
-
# Options to configure Radar. See [Radar Session](https://stripe.com/
|
|
2368
|
+
# Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.
|
|
2369
2369
|
attr_accessor :radar_options
|
|
2370
2370
|
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
|
|
2371
2371
|
attr_accessor :rechnung
|
|
@@ -2898,7 +2898,7 @@ module Stripe
|
|
|
2898
2898
|
attr_accessor :line2
|
|
2899
2899
|
# ZIP or postal code.
|
|
2900
2900
|
attr_accessor :postal_code
|
|
2901
|
-
# State, county, province, or region.
|
|
2901
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
2902
2902
|
attr_accessor :state
|
|
2903
2903
|
|
|
2904
2904
|
def initialize(
|
|
@@ -3012,7 +3012,7 @@ module Stripe
|
|
|
3012
3012
|
attr_accessor :cvc_token
|
|
3013
3013
|
# Installment configuration for payments attempted on this PaymentIntent.
|
|
3014
3014
|
#
|
|
3015
|
-
# For more information, see the [installments integration guide](https://stripe.com/
|
|
3015
|
+
# For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments).
|
|
3016
3016
|
attr_accessor :installments
|
|
3017
3017
|
# Configuration options for setting up an eMandate for cards issued in India.
|
|
3018
3018
|
attr_accessor :mandate_options
|
|
@@ -3022,19 +3022,19 @@ module Stripe
|
|
|
3022
3022
|
attr_accessor :moto
|
|
3023
3023
|
# Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.
|
|
3024
3024
|
attr_accessor :network
|
|
3025
|
-
# Request ability to [decrement the authorization](https://stripe.com/
|
|
3025
|
+
# Request ability to [decrement the authorization](https://docs.stripe.com/payments/decremental-authorization) for this PaymentIntent.
|
|
3026
3026
|
attr_accessor :request_decremental_authorization
|
|
3027
|
-
# Request ability to [capture beyond the standard authorization validity window](https://stripe.com/
|
|
3027
|
+
# Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this PaymentIntent.
|
|
3028
3028
|
attr_accessor :request_extended_authorization
|
|
3029
|
-
# Request ability to [increment the authorization](https://stripe.com/
|
|
3029
|
+
# Request ability to [increment the authorization](https://docs.stripe.com/payments/incremental-authorization) for this PaymentIntent.
|
|
3030
3030
|
attr_accessor :request_incremental_authorization
|
|
3031
|
-
# Request ability to make [multiple captures](https://stripe.com/
|
|
3031
|
+
# Request ability to make [multiple captures](https://docs.stripe.com/payments/multicapture) for this PaymentIntent.
|
|
3032
3032
|
attr_accessor :request_multicapture
|
|
3033
|
-
# Request ability to [overcapture](https://stripe.com/
|
|
3033
|
+
# Request ability to [overcapture](https://docs.stripe.com/payments/overcapture) for this PaymentIntent.
|
|
3034
3034
|
attr_accessor :request_overcapture
|
|
3035
3035
|
# Request partial authorization on this PaymentIntent.
|
|
3036
3036
|
attr_accessor :request_partial_authorization
|
|
3037
|
-
# 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/
|
|
3037
|
+
# 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.
|
|
3038
3038
|
attr_accessor :request_three_d_secure
|
|
3039
3039
|
# When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).
|
|
3040
3040
|
attr_accessor :require_cvc_recollection
|
|
@@ -3116,9 +3116,9 @@ module Stripe
|
|
|
3116
3116
|
#
|
|
3117
3117
|
# If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
|
|
3118
3118
|
attr_accessor :capture_method
|
|
3119
|
-
# Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/
|
|
3119
|
+
# Request ability to capture this payment beyond the standard [authorization validity window](https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity)
|
|
3120
3120
|
attr_accessor :request_extended_authorization
|
|
3121
|
-
# Request ability to [increment](https://stripe.com/
|
|
3121
|
+
# Request ability to [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://docs.stripe.com/api/payment_intents/confirm) response to verify support.
|
|
3122
3122
|
attr_accessor :request_incremental_authorization_support
|
|
3123
3123
|
# Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.
|
|
3124
3124
|
attr_accessor :routing
|
|
@@ -4723,7 +4723,7 @@ module Stripe
|
|
|
4723
4723
|
attr_accessor :capture_method
|
|
4724
4724
|
# The line items purchased by the customer.
|
|
4725
4725
|
attr_accessor :line_items
|
|
4726
|
-
# [Preferred locale](https://stripe.com/
|
|
4726
|
+
# [Preferred locale](https://docs.stripe.com/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
|
|
4727
4727
|
attr_accessor :preferred_locale
|
|
4728
4728
|
# 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.
|
|
4729
4729
|
attr_accessor :reference
|
|
@@ -5507,7 +5507,7 @@ module Stripe
|
|
|
5507
5507
|
attr_accessor :line2
|
|
5508
5508
|
# ZIP or postal code.
|
|
5509
5509
|
attr_accessor :postal_code
|
|
5510
|
-
# State, county, province, or region.
|
|
5510
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
5511
5511
|
attr_accessor :state
|
|
5512
5512
|
|
|
5513
5513
|
def initialize(
|
|
@@ -5556,11 +5556,11 @@ module Stripe
|
|
|
5556
5556
|
end
|
|
5557
5557
|
# Allocated Funds configuration for this PaymentIntent.
|
|
5558
5558
|
attr_accessor :allocated_funds
|
|
5559
|
-
# Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/
|
|
5559
|
+
# Amount intended to be collected by this PaymentIntent. 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).
|
|
5560
5560
|
attr_accessor :amount
|
|
5561
5561
|
# Provides industry-specific information about the amount.
|
|
5562
5562
|
attr_accessor :amount_details
|
|
5563
|
-
# 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/
|
|
5563
|
+
# 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).
|
|
5564
5564
|
attr_accessor :application_fee_amount
|
|
5565
5565
|
# Controls when the funds will be captured from the customer's account.
|
|
5566
5566
|
attr_accessor :capture_method
|
|
@@ -5570,13 +5570,13 @@ module Stripe
|
|
|
5570
5570
|
#
|
|
5571
5571
|
# Payment methods attached to other Customers cannot be used with this PaymentIntent.
|
|
5572
5572
|
#
|
|
5573
|
-
# If [setup_future_usage](https://stripe.com
|
|
5573
|
+
# If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.
|
|
5574
5574
|
attr_accessor :customer
|
|
5575
|
-
# ID of the Account this PaymentIntent belongs to, if one exists.
|
|
5575
|
+
# ID of the Account representing the customer that this PaymentIntent belongs to, if one exists.
|
|
5576
5576
|
#
|
|
5577
5577
|
# Payment methods attached to other Accounts cannot be used with this PaymentIntent.
|
|
5578
5578
|
#
|
|
5579
|
-
# If [setup_future_usage](https://stripe.com
|
|
5579
|
+
# If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.
|
|
5580
5580
|
attr_accessor :customer_account
|
|
5581
5581
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
|
5582
5582
|
attr_accessor :description
|
|
@@ -5590,16 +5590,16 @@ module Stripe
|
|
|
5590
5590
|
attr_accessor :hooks
|
|
5591
5591
|
# This hash contains details about the Mandate to create.
|
|
5592
5592
|
attr_accessor :mandate_data
|
|
5593
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
5593
|
+
# 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`.
|
|
5594
5594
|
attr_accessor :metadata
|
|
5595
5595
|
# Provides industry-specific information about the charge.
|
|
5596
5596
|
attr_accessor :payment_details
|
|
5597
5597
|
# Attribute for param field payment_method
|
|
5598
5598
|
attr_accessor :payment_method
|
|
5599
|
-
# The ID of the [payment method configuration](https://stripe.com/
|
|
5599
|
+
# The ID of the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this PaymentIntent.
|
|
5600
5600
|
attr_accessor :payment_method_configuration
|
|
5601
5601
|
# If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
|
|
5602
|
-
# in the [payment_method](https://stripe.com/
|
|
5602
|
+
# in the [payment_method](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method)
|
|
5603
5603
|
# property on the PaymentIntent.
|
|
5604
5604
|
attr_accessor :payment_method_data
|
|
5605
5605
|
# Payment-method-specific configuration for this PaymentIntent.
|
|
@@ -5626,9 +5626,9 @@ module Stripe
|
|
|
5626
5626
|
attr_accessor :statement_descriptor
|
|
5627
5627
|
# 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.
|
|
5628
5628
|
attr_accessor :statement_descriptor_suffix
|
|
5629
|
-
# Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/
|
|
5629
|
+
# Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts).
|
|
5630
5630
|
attr_accessor :transfer_data
|
|
5631
|
-
# A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/
|
|
5631
|
+
# A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts).
|
|
5632
5632
|
attr_accessor :transfer_group
|
|
5633
5633
|
|
|
5634
5634
|
def initialize(
|
|
@@ -14,7 +14,7 @@ module Stripe
|
|
|
14
14
|
end
|
|
15
15
|
|
|
16
16
|
class Redirect < ::Stripe::RequestParams
|
|
17
|
-
# The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/
|
|
17
|
+
# The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id) included.
|
|
18
18
|
attr_accessor :url
|
|
19
19
|
|
|
20
20
|
def initialize(url: nil)
|
|
@@ -291,7 +291,7 @@ module Stripe
|
|
|
291
291
|
attr_accessor :footer
|
|
292
292
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
|
293
293
|
attr_accessor :issuer
|
|
294
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
294
|
+
# 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`.
|
|
295
295
|
attr_accessor :metadata
|
|
296
296
|
# Default options for invoice PDF rendering for this customer.
|
|
297
297
|
attr_accessor :rendering_options
|
|
@@ -343,18 +343,28 @@ module Stripe
|
|
|
343
343
|
|
|
344
344
|
class PriceData < ::Stripe::RequestParams
|
|
345
345
|
class ProductData < ::Stripe::RequestParams
|
|
346
|
+
class TaxDetails < ::Stripe::RequestParams
|
|
347
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
348
|
+
attr_accessor :tax_code
|
|
349
|
+
|
|
350
|
+
def initialize(tax_code: nil)
|
|
351
|
+
@tax_code = tax_code
|
|
352
|
+
end
|
|
353
|
+
end
|
|
346
354
|
# 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.
|
|
347
355
|
attr_accessor :description
|
|
348
356
|
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
|
349
357
|
attr_accessor :images
|
|
350
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
358
|
+
# 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`.
|
|
351
359
|
attr_accessor :metadata
|
|
352
360
|
# The product's name, meant to be displayable to the customer.
|
|
353
361
|
attr_accessor :name
|
|
354
|
-
# A [tax code](https://stripe.com/
|
|
362
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
355
363
|
attr_accessor :tax_code
|
|
356
364
|
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
357
365
|
attr_accessor :unit_label
|
|
366
|
+
# Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.
|
|
367
|
+
attr_accessor :tax_details
|
|
358
368
|
|
|
359
369
|
def initialize(
|
|
360
370
|
description: nil,
|
|
@@ -362,7 +372,8 @@ module Stripe
|
|
|
362
372
|
metadata: nil,
|
|
363
373
|
name: nil,
|
|
364
374
|
tax_code: nil,
|
|
365
|
-
unit_label: nil
|
|
375
|
+
unit_label: nil,
|
|
376
|
+
tax_details: nil
|
|
366
377
|
)
|
|
367
378
|
@description = description
|
|
368
379
|
@images = images
|
|
@@ -370,6 +381,7 @@ module Stripe
|
|
|
370
381
|
@name = name
|
|
371
382
|
@tax_code = tax_code
|
|
372
383
|
@unit_label = unit_label
|
|
384
|
+
@tax_details = tax_details
|
|
373
385
|
end
|
|
374
386
|
end
|
|
375
387
|
|
|
@@ -392,7 +404,7 @@ module Stripe
|
|
|
392
404
|
attr_accessor :product_data
|
|
393
405
|
# The recurring components of a price such as `interval` and `interval_count`.
|
|
394
406
|
attr_accessor :recurring
|
|
395
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
407
|
+
# 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.
|
|
396
408
|
attr_accessor :tax_behavior
|
|
397
409
|
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
|
|
398
410
|
attr_accessor :unit_amount
|
|
@@ -419,9 +431,9 @@ module Stripe
|
|
|
419
431
|
end
|
|
420
432
|
# When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
|
|
421
433
|
attr_accessor :adjustable_quantity
|
|
422
|
-
# The ID of the [Price](https://stripe.com/
|
|
434
|
+
# 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.
|
|
423
435
|
attr_accessor :price
|
|
424
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
436
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
425
437
|
attr_accessor :price_data
|
|
426
438
|
# The quantity of the line item being purchased.
|
|
427
439
|
attr_accessor :quantity
|
|
@@ -486,7 +498,7 @@ module Stripe
|
|
|
486
498
|
end
|
|
487
499
|
# 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.
|
|
488
500
|
attr_accessor :adjustable_quantity
|
|
489
|
-
# The ID of the [Price](https://stripe.com/
|
|
501
|
+
# The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object.
|
|
490
502
|
attr_accessor :price
|
|
491
503
|
# The initial quantity of the line item created when a customer chooses to add this optional item to their order.
|
|
492
504
|
attr_accessor :quantity
|
|
@@ -503,9 +515,9 @@ module Stripe
|
|
|
503
515
|
attr_accessor :capture_method
|
|
504
516
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
|
505
517
|
attr_accessor :description
|
|
506
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
518
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
507
519
|
attr_accessor :metadata
|
|
508
|
-
# Indicates that you intend to [make future payments](https://stripe.com/
|
|
520
|
+
# Indicates that you intend to [make future payments](https://docs.stripe.com/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.
|
|
509
521
|
#
|
|
510
522
|
# When setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved.
|
|
511
523
|
#
|
|
@@ -523,7 +535,7 @@ module Stripe
|
|
|
523
535
|
attr_accessor :statement_descriptor
|
|
524
536
|
# 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.
|
|
525
537
|
attr_accessor :statement_descriptor_suffix
|
|
526
|
-
# A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/
|
|
538
|
+
# 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.
|
|
527
539
|
attr_accessor :transfer_group
|
|
528
540
|
|
|
529
541
|
def initialize(
|
|
@@ -631,7 +643,7 @@ module Stripe
|
|
|
631
643
|
attr_accessor :description
|
|
632
644
|
# All invoices will be billed using the specified settings.
|
|
633
645
|
attr_accessor :invoice_settings
|
|
634
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
646
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
635
647
|
attr_accessor :metadata
|
|
636
648
|
# Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
|
|
637
649
|
attr_accessor :trial_period_days
|
|
@@ -699,7 +711,7 @@ module Stripe
|
|
|
699
711
|
attr_accessor :custom_fields
|
|
700
712
|
# Display additional text for your customers using custom text.
|
|
701
713
|
attr_accessor :custom_text
|
|
702
|
-
# Configures whether [checkout sessions](https://stripe.com/
|
|
714
|
+
# Configures whether [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link create a [Customer](https://docs.stripe.com/api/customers).
|
|
703
715
|
attr_accessor :customer_creation
|
|
704
716
|
# Specifies which fields in the response should be expanded.
|
|
705
717
|
attr_accessor :expand
|
|
@@ -709,13 +721,13 @@ module Stripe
|
|
|
709
721
|
attr_accessor :invoice_creation
|
|
710
722
|
# The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
|
|
711
723
|
attr_accessor :line_items
|
|
712
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
724
|
+
# 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link.
|
|
713
725
|
attr_accessor :metadata
|
|
714
726
|
# Controls settings applied for collecting the customer's name.
|
|
715
727
|
attr_accessor :name_collection
|
|
716
728
|
# The account on behalf of which to charge.
|
|
717
729
|
attr_accessor :on_behalf_of
|
|
718
|
-
# 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/
|
|
730
|
+
# 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).
|
|
719
731
|
# There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items.
|
|
720
732
|
# There is a maximum of 20 combined line items and optional items.
|
|
721
733
|
attr_accessor :optional_items
|
|
@@ -725,9 +737,9 @@ module Stripe
|
|
|
725
737
|
#
|
|
726
738
|
# Can only be set in `subscription` mode. Defaults to `always`.
|
|
727
739
|
#
|
|
728
|
-
# 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/
|
|
740
|
+
# 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).
|
|
729
741
|
attr_accessor :payment_method_collection
|
|
730
|
-
# The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/
|
|
742
|
+
# The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://docs.stripe.com/payments/payment-methods/integration-options#payment-method-product-support)).
|
|
731
743
|
attr_accessor :payment_method_types
|
|
732
744
|
# Controls phone number collection settings during checkout.
|
|
733
745
|
#
|
|
@@ -737,9 +749,9 @@ module Stripe
|
|
|
737
749
|
attr_accessor :restrictions
|
|
738
750
|
# Configuration for collecting the customer's shipping address.
|
|
739
751
|
attr_accessor :shipping_address_collection
|
|
740
|
-
# The shipping rate options to apply to [checkout sessions](https://stripe.com/
|
|
752
|
+
# The shipping rate options to apply to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link.
|
|
741
753
|
attr_accessor :shipping_options
|
|
742
|
-
# Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/
|
|
754
|
+
# Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://docs.stripe.com/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
|
|
743
755
|
attr_accessor :submit_type
|
|
744
756
|
# When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
|
|
745
757
|
attr_accessor :subscription_data
|
|
@@ -14,7 +14,7 @@ module Stripe
|
|
|
14
14
|
end
|
|
15
15
|
|
|
16
16
|
class Redirect < ::Stripe::RequestParams
|
|
17
|
-
# The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://stripe.com/
|
|
17
|
+
# The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id) included.
|
|
18
18
|
attr_accessor :url
|
|
19
19
|
|
|
20
20
|
def initialize(url: nil)
|
|
@@ -264,7 +264,7 @@ module Stripe
|
|
|
264
264
|
attr_accessor :footer
|
|
265
265
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
|
266
266
|
attr_accessor :issuer
|
|
267
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
267
|
+
# 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`.
|
|
268
268
|
attr_accessor :metadata
|
|
269
269
|
# Default options for invoice PDF rendering for this customer.
|
|
270
270
|
attr_accessor :rendering_options
|
|
@@ -365,7 +365,7 @@ module Stripe
|
|
|
365
365
|
class PaymentIntentData < ::Stripe::RequestParams
|
|
366
366
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
|
367
367
|
attr_accessor :description
|
|
368
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
368
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
369
369
|
attr_accessor :metadata
|
|
370
370
|
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
|
|
371
371
|
#
|
|
@@ -373,7 +373,7 @@ module Stripe
|
|
|
373
373
|
attr_accessor :statement_descriptor
|
|
374
374
|
# 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.
|
|
375
375
|
attr_accessor :statement_descriptor_suffix
|
|
376
|
-
# A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/
|
|
376
|
+
# 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.
|
|
377
377
|
attr_accessor :transfer_group
|
|
378
378
|
|
|
379
379
|
def initialize(
|
|
@@ -466,7 +466,7 @@ module Stripe
|
|
|
466
466
|
end
|
|
467
467
|
# All invoices will be billed using the specified settings.
|
|
468
468
|
attr_accessor :invoice_settings
|
|
469
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
469
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
470
470
|
attr_accessor :metadata
|
|
471
471
|
# Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
|
|
472
472
|
attr_accessor :trial_period_days
|
|
@@ -511,7 +511,7 @@ module Stripe
|
|
|
511
511
|
attr_accessor :custom_fields
|
|
512
512
|
# Display additional text for your customers using custom text.
|
|
513
513
|
attr_accessor :custom_text
|
|
514
|
-
# Configures whether [checkout sessions](https://stripe.com/
|
|
514
|
+
# Configures whether [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link create a [Customer](https://docs.stripe.com/api/customers).
|
|
515
515
|
attr_accessor :customer_creation
|
|
516
516
|
# Specifies which fields in the response should be expanded.
|
|
517
517
|
attr_accessor :expand
|
|
@@ -521,7 +521,7 @@ module Stripe
|
|
|
521
521
|
attr_accessor :invoice_creation
|
|
522
522
|
# The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
|
|
523
523
|
attr_accessor :line_items
|
|
524
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
524
|
+
# 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link.
|
|
525
525
|
attr_accessor :metadata
|
|
526
526
|
# Controls settings applied for collecting the customer's name.
|
|
527
527
|
attr_accessor :name_collection
|
|
@@ -531,7 +531,7 @@ module Stripe
|
|
|
531
531
|
#
|
|
532
532
|
# Can only be set in `subscription` mode. Defaults to `always`.
|
|
533
533
|
#
|
|
534
|
-
# 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/
|
|
534
|
+
# 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).
|
|
535
535
|
attr_accessor :payment_method_collection
|
|
536
536
|
# The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
|
|
537
537
|
attr_accessor :payment_method_types
|
|
@@ -543,7 +543,7 @@ module Stripe
|
|
|
543
543
|
attr_accessor :restrictions
|
|
544
544
|
# Configuration for collecting the customer's shipping address.
|
|
545
545
|
attr_accessor :shipping_address_collection
|
|
546
|
-
# Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/
|
|
546
|
+
# Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://docs.stripe.com/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
|
|
547
547
|
attr_accessor :submit_type
|
|
548
548
|
# When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
|
|
549
549
|
attr_accessor :subscription_data
|
|
@@ -5,7 +5,7 @@ module Stripe
|
|
|
5
5
|
class PaymentMethodAttachParams < ::Stripe::RequestParams
|
|
6
6
|
# The ID of the customer to which to attach the PaymentMethod.
|
|
7
7
|
attr_accessor :customer
|
|
8
|
-
# The ID of the
|
|
8
|
+
# The ID of the Account representing the customer to which to attach the PaymentMethod.
|
|
9
9
|
attr_accessor :customer_account
|
|
10
10
|
# Specifies which fields in the response should be expanded.
|
|
11
11
|
attr_accessor :expand
|