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
|
@@ -87,7 +87,7 @@ module Stripe
|
|
|
87
87
|
attr_accessor :currency
|
|
88
88
|
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
|
|
89
89
|
attr_accessor :product
|
|
90
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
90
|
+
# 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.
|
|
91
91
|
attr_accessor :tax_behavior
|
|
92
92
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
|
|
93
93
|
attr_accessor :unit_amount
|
|
@@ -110,13 +110,13 @@ module Stripe
|
|
|
110
110
|
end
|
|
111
111
|
# The coupons to redeem into discounts for the item.
|
|
112
112
|
attr_accessor :discounts
|
|
113
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
113
|
+
# 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`.
|
|
114
114
|
attr_accessor :metadata
|
|
115
115
|
# The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
|
|
116
116
|
attr_accessor :period
|
|
117
117
|
# The ID of the price object. One of `price` or `price_data` is required.
|
|
118
118
|
attr_accessor :price
|
|
119
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
119
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
120
120
|
attr_accessor :price_data
|
|
121
121
|
# Quantity for this item. Defaults to 1.
|
|
122
122
|
attr_accessor :quantity
|
|
@@ -309,7 +309,7 @@ module Stripe
|
|
|
309
309
|
|
|
310
310
|
class Item < ::Stripe::RequestParams
|
|
311
311
|
class BillingThresholds < ::Stripe::RequestParams
|
|
312
|
-
# Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/
|
|
312
|
+
# Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
|
313
313
|
attr_accessor :usage_gte
|
|
314
314
|
|
|
315
315
|
def initialize(usage_gte: nil)
|
|
@@ -390,7 +390,7 @@ module Stripe
|
|
|
390
390
|
attr_accessor :product
|
|
391
391
|
# The recurring components of a price such as `interval` and `interval_count`.
|
|
392
392
|
attr_accessor :recurring
|
|
393
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
393
|
+
# 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.
|
|
394
394
|
attr_accessor :tax_behavior
|
|
395
395
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
|
396
396
|
attr_accessor :unit_amount
|
|
@@ -417,30 +417,31 @@ module Stripe
|
|
|
417
417
|
attr_accessor :billing_thresholds
|
|
418
418
|
# Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
|
|
419
419
|
attr_accessor :clear_usage
|
|
420
|
+
# The trial offer to apply to this subscription item.
|
|
421
|
+
attr_accessor :current_trial
|
|
420
422
|
# A flag that, if set to `true`, will delete the specified item.
|
|
421
423
|
attr_accessor :deleted
|
|
422
424
|
# The coupons to redeem into discounts for the subscription item.
|
|
423
425
|
attr_accessor :discounts
|
|
424
426
|
# Subscription item to update.
|
|
425
427
|
attr_accessor :id
|
|
426
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
428
|
+
# 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`.
|
|
427
429
|
attr_accessor :metadata
|
|
428
430
|
# Plan ID for this item, as a string.
|
|
429
431
|
attr_accessor :plan
|
|
430
432
|
# The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
|
|
431
433
|
attr_accessor :price
|
|
432
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
434
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
433
435
|
attr_accessor :price_data
|
|
434
436
|
# Quantity for this item.
|
|
435
437
|
attr_accessor :quantity
|
|
436
|
-
# A list of [Tax Rate](https://stripe.com/
|
|
438
|
+
# A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
437
439
|
attr_accessor :tax_rates
|
|
438
|
-
# The trial offer to apply to this subscription item.
|
|
439
|
-
attr_accessor :current_trial
|
|
440
440
|
|
|
441
441
|
def initialize(
|
|
442
442
|
billing_thresholds: nil,
|
|
443
443
|
clear_usage: nil,
|
|
444
|
+
current_trial: nil,
|
|
444
445
|
deleted: nil,
|
|
445
446
|
discounts: nil,
|
|
446
447
|
id: nil,
|
|
@@ -449,11 +450,11 @@ module Stripe
|
|
|
449
450
|
price: nil,
|
|
450
451
|
price_data: nil,
|
|
451
452
|
quantity: nil,
|
|
452
|
-
tax_rates: nil
|
|
453
|
-
current_trial: nil
|
|
453
|
+
tax_rates: nil
|
|
454
454
|
)
|
|
455
455
|
@billing_thresholds = billing_thresholds
|
|
456
456
|
@clear_usage = clear_usage
|
|
457
|
+
@current_trial = current_trial
|
|
457
458
|
@deleted = deleted
|
|
458
459
|
@discounts = discounts
|
|
459
460
|
@id = id
|
|
@@ -463,7 +464,6 @@ module Stripe
|
|
|
463
464
|
@price_data = price_data
|
|
464
465
|
@quantity = quantity
|
|
465
466
|
@tax_rates = tax_rates
|
|
466
|
-
@current_trial = current_trial
|
|
467
467
|
end
|
|
468
468
|
end
|
|
469
469
|
|
|
@@ -529,7 +529,7 @@ module Stripe
|
|
|
529
529
|
attr_accessor :mandate_options
|
|
530
530
|
# Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
|
|
531
531
|
attr_accessor :network
|
|
532
|
-
# 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/
|
|
532
|
+
# 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. 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.
|
|
533
533
|
attr_accessor :request_three_d_secure
|
|
534
534
|
|
|
535
535
|
def initialize(mandate_options: nil, network: nil, request_three_d_secure: nil)
|
|
@@ -573,6 +573,26 @@ module Stripe
|
|
|
573
573
|
class IdBankTransfer < ::Stripe::RequestParams; end
|
|
574
574
|
class Konbini < ::Stripe::RequestParams; end
|
|
575
575
|
|
|
576
|
+
class Payto < ::Stripe::RequestParams
|
|
577
|
+
class MandateOptions < ::Stripe::RequestParams
|
|
578
|
+
# The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
|
|
579
|
+
attr_accessor :amount
|
|
580
|
+
# The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
581
|
+
attr_accessor :purpose
|
|
582
|
+
|
|
583
|
+
def initialize(amount: nil, purpose: nil)
|
|
584
|
+
@amount = amount
|
|
585
|
+
@purpose = purpose
|
|
586
|
+
end
|
|
587
|
+
end
|
|
588
|
+
# Additional fields for Mandate creation.
|
|
589
|
+
attr_accessor :mandate_options
|
|
590
|
+
|
|
591
|
+
def initialize(mandate_options: nil)
|
|
592
|
+
@mandate_options = mandate_options
|
|
593
|
+
end
|
|
594
|
+
end
|
|
595
|
+
|
|
576
596
|
class Pix < ::Stripe::RequestParams
|
|
577
597
|
class MandateOptions < ::Stripe::RequestParams
|
|
578
598
|
# Amount to be charged for future payments. If not provided, defaults to 40000.
|
|
@@ -680,6 +700,8 @@ module Stripe
|
|
|
680
700
|
attr_accessor :id_bank_transfer
|
|
681
701
|
# This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
|
682
702
|
attr_accessor :konbini
|
|
703
|
+
# This sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
|
|
704
|
+
attr_accessor :payto
|
|
683
705
|
# This sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
|
|
684
706
|
attr_accessor :pix
|
|
685
707
|
# This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
|
|
@@ -696,6 +718,7 @@ module Stripe
|
|
|
696
718
|
customer_balance: nil,
|
|
697
719
|
id_bank_transfer: nil,
|
|
698
720
|
konbini: nil,
|
|
721
|
+
payto: nil,
|
|
699
722
|
pix: nil,
|
|
700
723
|
sepa_debit: nil,
|
|
701
724
|
upi: nil,
|
|
@@ -707,6 +730,7 @@ module Stripe
|
|
|
707
730
|
@customer_balance = customer_balance
|
|
708
731
|
@id_bank_transfer = id_bank_transfer
|
|
709
732
|
@konbini = konbini
|
|
733
|
+
@payto = payto
|
|
710
734
|
@pix = pix
|
|
711
735
|
@sepa_debit = sepa_debit
|
|
712
736
|
@upi = upi
|
|
@@ -791,7 +815,7 @@ module Stripe
|
|
|
791
815
|
attr_accessor :automatic_tax
|
|
792
816
|
# The Billing Cadence which controls the timing of recurring invoice generation for this subscription. If unset, the subscription will bill according to its own configured schedule and create its own invoices. If set, this subscription will be billed by the cadence instead, potentially sharing invoices with the other subscriptions linked to that Cadence.
|
|
793
817
|
attr_accessor :billing_cadence
|
|
794
|
-
# Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/
|
|
818
|
+
# Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
|
|
795
819
|
attr_accessor :billing_cycle_anchor
|
|
796
820
|
# Sets the billing schedules for the subscription.
|
|
797
821
|
attr_accessor :billing_schedules
|
|
@@ -807,9 +831,9 @@ module Stripe
|
|
|
807
831
|
attr_accessor :collection_method
|
|
808
832
|
# Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
|
|
809
833
|
attr_accessor :days_until_due
|
|
810
|
-
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/
|
|
834
|
+
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
|
|
811
835
|
attr_accessor :default_payment_method
|
|
812
|
-
# ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/
|
|
836
|
+
# ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
|
|
813
837
|
attr_accessor :default_source
|
|
814
838
|
# The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates.
|
|
815
839
|
attr_accessor :default_tax_rates
|
|
@@ -823,29 +847,29 @@ module Stripe
|
|
|
823
847
|
attr_accessor :invoice_settings
|
|
824
848
|
# A list of up to 20 subscription items, each with an attached price.
|
|
825
849
|
attr_accessor :items
|
|
826
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
850
|
+
# 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`.
|
|
827
851
|
attr_accessor :metadata
|
|
828
852
|
# Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
|
|
829
853
|
attr_accessor :off_session
|
|
830
854
|
# The account on behalf of which to charge, for each of the subscription's invoices.
|
|
831
855
|
attr_accessor :on_behalf_of
|
|
832
|
-
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/
|
|
856
|
+
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
|
|
833
857
|
attr_accessor :pause_collection
|
|
834
|
-
# Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/
|
|
858
|
+
# Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
|
|
835
859
|
#
|
|
836
|
-
# Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/
|
|
860
|
+
# Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
|
|
837
861
|
#
|
|
838
|
-
# Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/
|
|
862
|
+
# Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes).
|
|
839
863
|
#
|
|
840
864
|
# Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
|
|
841
865
|
attr_accessor :payment_behavior
|
|
842
866
|
# Payment settings to pass to invoices created by the subscription.
|
|
843
867
|
attr_accessor :payment_settings
|
|
844
|
-
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/
|
|
868
|
+
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval.
|
|
845
869
|
attr_accessor :pending_invoice_item_interval
|
|
846
870
|
# If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
847
871
|
attr_accessor :prebilling
|
|
848
|
-
# Determines how to handle [prorations](https://stripe.com/
|
|
872
|
+
# Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
|
|
849
873
|
attr_accessor :proration_behavior
|
|
850
874
|
# If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
|
|
851
875
|
attr_accessor :proration_date
|
|
@@ -853,7 +877,7 @@ module Stripe
|
|
|
853
877
|
attr_accessor :transfer_data
|
|
854
878
|
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, `trial_end` will override the default trial period of the plan the customer is being subscribed to. The `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
|
|
855
879
|
attr_accessor :trial_end
|
|
856
|
-
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/
|
|
880
|
+
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
|
|
857
881
|
attr_accessor :trial_from_plan
|
|
858
882
|
# Settings related to subscription trials.
|
|
859
883
|
attr_accessor :trial_settings
|
|
@@ -6,7 +6,7 @@ module Stripe
|
|
|
6
6
|
class AssociationFindParams < ::Stripe::RequestParams
|
|
7
7
|
# Specifies which fields in the response should be expanded.
|
|
8
8
|
attr_accessor :expand
|
|
9
|
-
# Valid [PaymentIntent](https://stripe.com/
|
|
9
|
+
# Valid [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) id
|
|
10
10
|
attr_accessor :payment_intent
|
|
11
11
|
|
|
12
12
|
def initialize(expand: nil, payment_intent: nil)
|
|
@@ -74,20 +74,20 @@ module Stripe
|
|
|
74
74
|
end
|
|
75
75
|
|
|
76
76
|
class LineItem < ::Stripe::RequestParams
|
|
77
|
-
# A positive integer representing the line item's total price in the [smallest currency unit](https://stripe.com/
|
|
77
|
+
# A positive integer representing the line item's total price in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
78
78
|
# If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.
|
|
79
79
|
attr_accessor :amount
|
|
80
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
80
|
+
# 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.
|
|
81
81
|
attr_accessor :metadata
|
|
82
82
|
# If provided, the product's `tax_code` will be used as the line item's `tax_code`.
|
|
83
83
|
attr_accessor :product
|
|
84
84
|
# The number of units of the item being purchased. Used to calculate the per-unit price from the total `amount` for the line. For example, if `amount=100` and `quantity=4`, the calculated unit price is 25.
|
|
85
85
|
attr_accessor :quantity
|
|
86
|
-
# A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported [tax reports](https://stripe.com/
|
|
86
|
+
# A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported [tax reports](https://docs.stripe.com/tax/reports).
|
|
87
87
|
attr_accessor :reference
|
|
88
88
|
# Specifies whether the `amount` includes taxes. Defaults to `exclusive`.
|
|
89
89
|
attr_accessor :tax_behavior
|
|
90
|
-
# A [tax code](https://stripe.com/
|
|
90
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID to use for this line item. If not provided, we will use the tax code from the provided `product` param. If neither `tax_code` nor `product` is provided, we will use the default tax code from your Tax Settings.
|
|
91
91
|
attr_accessor :tax_code
|
|
92
92
|
|
|
93
93
|
def initialize(
|
|
@@ -149,13 +149,13 @@ module Stripe
|
|
|
149
149
|
end
|
|
150
150
|
|
|
151
151
|
class ShippingCost < ::Stripe::RequestParams
|
|
152
|
-
# A positive integer in the [smallest currency unit](https://stripe.com/
|
|
152
|
+
# A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) representing the shipping charge. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.
|
|
153
153
|
attr_accessor :amount
|
|
154
|
-
# If provided, the [shipping rate](https://stripe.com/
|
|
154
|
+
# If provided, the [shipping rate](https://docs.stripe.com/api/shipping_rates/object)'s `amount`, `tax_code` and `tax_behavior` are used. If you provide a shipping rate, then you cannot pass the `amount`, `tax_code`, or `tax_behavior` parameters.
|
|
155
155
|
attr_accessor :shipping_rate
|
|
156
156
|
# Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. Defaults to `exclusive`.
|
|
157
157
|
attr_accessor :tax_behavior
|
|
158
|
-
# The [tax code](https://stripe.com/
|
|
158
|
+
# The [tax code](https://docs.stripe.com/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](https://dashboard.stripe.com/settings/tax) is used.
|
|
159
159
|
attr_accessor :tax_code
|
|
160
160
|
|
|
161
161
|
def initialize(amount: nil, shipping_rate: nil, tax_behavior: nil, tax_code: nil)
|
|
@@ -7,7 +7,7 @@ module Stripe
|
|
|
7
7
|
class Defaults < ::Stripe::RequestParams
|
|
8
8
|
# Specifies the default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) to be used when the item's price has unspecified tax behavior. One of inclusive, exclusive, or inferred_by_currency. Once specified, it cannot be changed back to null.
|
|
9
9
|
attr_accessor :tax_behavior
|
|
10
|
-
# A [tax code](https://stripe.com/
|
|
10
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
11
11
|
attr_accessor :tax_code
|
|
12
12
|
|
|
13
13
|
def initialize(tax_behavior: nil, tax_code: nil)
|
|
@@ -8,7 +8,7 @@ module Stripe
|
|
|
8
8
|
attr_accessor :calculation
|
|
9
9
|
# Specifies which fields in the response should be expanded.
|
|
10
10
|
attr_accessor :expand
|
|
11
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
11
|
+
# 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`.
|
|
12
12
|
attr_accessor :metadata
|
|
13
13
|
# The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time.
|
|
14
14
|
attr_accessor :posted_at
|
|
@@ -5,15 +5,15 @@ module Stripe
|
|
|
5
5
|
module Tax
|
|
6
6
|
class TransactionCreateReversalParams < ::Stripe::RequestParams
|
|
7
7
|
class LineItem < ::Stripe::RequestParams
|
|
8
|
-
# The amount to reverse, in the [smallest currency unit](https://stripe.com/
|
|
8
|
+
# The amount to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative.
|
|
9
9
|
attr_accessor :amount
|
|
10
|
-
# The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/
|
|
10
|
+
# The amount of tax to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative.
|
|
11
11
|
attr_accessor :amount_tax
|
|
12
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
12
|
+
# 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.
|
|
13
13
|
attr_accessor :metadata
|
|
14
14
|
# The `id` of the line item to reverse in the original transaction.
|
|
15
15
|
attr_accessor :original_line_item
|
|
16
|
-
# The quantity reversed. Appears in [tax exports](https://stripe.com/
|
|
16
|
+
# The quantity reversed. Appears in [tax exports](https://docs.stripe.com/tax/reports), but does not affect the amount of tax reversed.
|
|
17
17
|
attr_accessor :quantity
|
|
18
18
|
# A custom identifier for this line item in the reversal transaction, such as 'L1-refund'.
|
|
19
19
|
attr_accessor :reference
|
|
@@ -36,9 +36,9 @@ module Stripe
|
|
|
36
36
|
end
|
|
37
37
|
|
|
38
38
|
class ShippingCost < ::Stripe::RequestParams
|
|
39
|
-
# The amount to reverse, in the [smallest currency unit](https://stripe.com/
|
|
39
|
+
# The amount to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative.
|
|
40
40
|
attr_accessor :amount
|
|
41
|
-
# The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/
|
|
41
|
+
# The amount of tax to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative.
|
|
42
42
|
attr_accessor :amount_tax
|
|
43
43
|
|
|
44
44
|
def initialize(amount: nil, amount_tax: nil)
|
|
@@ -48,17 +48,17 @@ module Stripe
|
|
|
48
48
|
end
|
|
49
49
|
# Specifies which fields in the response should be expanded.
|
|
50
50
|
attr_accessor :expand
|
|
51
|
-
# A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/
|
|
51
|
+
# A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes.
|
|
52
52
|
attr_accessor :flat_amount
|
|
53
53
|
# The line item amounts to reverse.
|
|
54
54
|
attr_accessor :line_items
|
|
55
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
55
|
+
# 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`.
|
|
56
56
|
attr_accessor :metadata
|
|
57
57
|
# If `partial`, the provided line item or shipping cost amounts are reversed. If `full`, the original transaction is fully reversed.
|
|
58
58
|
attr_accessor :mode
|
|
59
59
|
# The ID of the Transaction to partially or fully reverse.
|
|
60
60
|
attr_accessor :original_transaction
|
|
61
|
-
# A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://stripe.com/
|
|
61
|
+
# A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://docs.stripe.com/tax/reports).
|
|
62
62
|
attr_accessor :reference
|
|
63
63
|
# The shipping cost to reverse.
|
|
64
64
|
attr_accessor :shipping_cost
|
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
module Stripe
|
|
5
5
|
class TaxIdCreateParams < ::Stripe::RequestParams
|
|
6
6
|
class Owner < ::Stripe::RequestParams
|
|
7
|
-
# Account the tax ID belongs to. Required when `type=account`
|
|
7
|
+
# Connected Account the tax ID belongs to. Required when `type=account`
|
|
8
8
|
attr_accessor :account
|
|
9
9
|
# Customer the tax ID belongs to. Required when `type=customer`
|
|
10
10
|
attr_accessor :customer
|
|
11
|
-
#
|
|
11
|
+
# ID of the Account representing the customer that the tax ID belongs to. Can be used in place of `customer` when `type=customer`
|
|
12
12
|
attr_accessor :customer_account
|
|
13
13
|
# Type of owner referenced.
|
|
14
14
|
attr_accessor :type
|
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
module Stripe
|
|
5
5
|
class TaxIdListParams < ::Stripe::RequestParams
|
|
6
6
|
class Owner < ::Stripe::RequestParams
|
|
7
|
-
# Account the tax ID belongs to. Required when `type=account`
|
|
7
|
+
# Connected Account the tax ID belongs to. Required when `type=account`
|
|
8
8
|
attr_accessor :account
|
|
9
9
|
# Customer the tax ID belongs to. Required when `type=customer`
|
|
10
10
|
attr_accessor :customer
|
|
11
|
-
#
|
|
11
|
+
# ID of the Account representing the customer that the tax ID belongs to. Can be used in place of `customer` when `type=customer`
|
|
12
12
|
attr_accessor :customer_account
|
|
13
13
|
# Type of owner referenced.
|
|
14
14
|
attr_accessor :type
|
|
@@ -17,7 +17,7 @@ module Stripe
|
|
|
17
17
|
attr_accessor :inclusive
|
|
18
18
|
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
|
|
19
19
|
attr_accessor :jurisdiction
|
|
20
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
20
|
+
# 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`.
|
|
21
21
|
attr_accessor :metadata
|
|
22
22
|
# This represents the tax rate percent out of 100.
|
|
23
23
|
attr_accessor :percentage
|
|
@@ -15,7 +15,7 @@ module Stripe
|
|
|
15
15
|
attr_accessor :expand
|
|
16
16
|
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
|
|
17
17
|
attr_accessor :jurisdiction
|
|
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
|
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
|
|
21
21
|
attr_accessor :state
|
|
@@ -15,7 +15,7 @@ module Stripe
|
|
|
15
15
|
attr_accessor :line2
|
|
16
16
|
# ZIP or postal code.
|
|
17
17
|
attr_accessor :postal_code
|
|
18
|
-
# State, county, province, or region.
|
|
18
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
19
19
|
attr_accessor :state
|
|
20
20
|
|
|
21
21
|
def initialize(
|
|
@@ -120,7 +120,7 @@ module Stripe
|
|
|
120
120
|
attr_accessor :display_name_kanji
|
|
121
121
|
# Specifies which fields in the response should be expanded.
|
|
122
122
|
attr_accessor :expand
|
|
123
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
123
|
+
# 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`.
|
|
124
124
|
attr_accessor :metadata
|
|
125
125
|
# The phone number for the location.
|
|
126
126
|
attr_accessor :phone
|
|
@@ -15,7 +15,7 @@ module Stripe
|
|
|
15
15
|
attr_accessor :line2
|
|
16
16
|
# ZIP or postal code.
|
|
17
17
|
attr_accessor :postal_code
|
|
18
|
-
# State, county, province, or region.
|
|
18
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
19
19
|
attr_accessor :state
|
|
20
20
|
|
|
21
21
|
def initialize(
|
|
@@ -120,7 +120,7 @@ module Stripe
|
|
|
120
120
|
attr_accessor :display_name_kanji
|
|
121
121
|
# Specifies which fields in the response should be expanded.
|
|
122
122
|
attr_accessor :expand
|
|
123
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
123
|
+
# 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`.
|
|
124
124
|
attr_accessor :metadata
|
|
125
125
|
# The phone number for the location.
|
|
126
126
|
attr_accessor :phone
|
|
@@ -83,7 +83,7 @@ module Stripe
|
|
|
83
83
|
attr_accessor :expand
|
|
84
84
|
# List of inputs to be collected from the customer using the Reader. Maximum 5 inputs.
|
|
85
85
|
attr_accessor :inputs
|
|
86
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
86
|
+
# 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`.
|
|
87
87
|
attr_accessor :metadata
|
|
88
88
|
|
|
89
89
|
def initialize(expand: nil, inputs: nil, metadata: nil)
|
|
@@ -10,7 +10,7 @@ module Stripe
|
|
|
10
10
|
attr_accessor :label
|
|
11
11
|
# The location to assign the reader to.
|
|
12
12
|
attr_accessor :location
|
|
13
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
13
|
+
# 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`.
|
|
14
14
|
attr_accessor :metadata
|
|
15
15
|
# A code generated by the reader used for registering to an account.
|
|
16
16
|
attr_accessor :registration_code
|
|
@@ -18,7 +18,7 @@ module Stripe
|
|
|
18
18
|
attr_accessor :charge
|
|
19
19
|
# Specifies which fields in the response should be expanded.
|
|
20
20
|
attr_accessor :expand
|
|
21
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
21
|
+
# 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`.
|
|
22
22
|
attr_accessor :metadata
|
|
23
23
|
# ID of the PaymentIntent to refund.
|
|
24
24
|
attr_accessor :payment_intent
|
|
@@ -6,7 +6,7 @@ module Stripe
|
|
|
6
6
|
class ReaderSetReaderDisplayParams < ::Stripe::RequestParams
|
|
7
7
|
class Cart < ::Stripe::RequestParams
|
|
8
8
|
class LineItem < ::Stripe::RequestParams
|
|
9
|
-
# The price of the item in the [smallest currency unit](https://stripe.com/
|
|
9
|
+
# The price of the item in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
10
10
|
attr_accessor :amount
|
|
11
11
|
# The description or name of the item.
|
|
12
12
|
attr_accessor :description
|
|
@@ -23,9 +23,9 @@ module Stripe
|
|
|
23
23
|
attr_accessor :currency
|
|
24
24
|
# Array of line items to display.
|
|
25
25
|
attr_accessor :line_items
|
|
26
|
-
# The amount of tax in the [smallest currency unit](https://stripe.com/
|
|
26
|
+
# The amount of tax in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
27
27
|
attr_accessor :tax
|
|
28
|
-
# Total balance of cart due in the [smallest currency unit](https://stripe.com/
|
|
28
|
+
# Total balance of cart due in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
29
29
|
attr_accessor :total
|
|
30
30
|
|
|
31
31
|
def initialize(currency: nil, line_items: nil, tax: nil, total: nil)
|
|
@@ -8,7 +8,7 @@ module Stripe
|
|
|
8
8
|
attr_accessor :expand
|
|
9
9
|
# The new label of the reader.
|
|
10
10
|
attr_accessor :label
|
|
11
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
11
|
+
# 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`.
|
|
12
12
|
attr_accessor :metadata
|
|
13
13
|
|
|
14
14
|
def initialize(expand: nil, label: nil, metadata: nil)
|
|
@@ -65,7 +65,7 @@ module Stripe
|
|
|
65
65
|
attr_accessor :line2
|
|
66
66
|
# ZIP or postal code.
|
|
67
67
|
attr_accessor :postal_code
|
|
68
|
-
# State, county, province, or region.
|
|
68
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
69
69
|
attr_accessor :state
|
|
70
70
|
|
|
71
71
|
def initialize(
|
|
@@ -272,7 +272,7 @@ module Stripe
|
|
|
272
272
|
class Qris < ::Stripe::RequestParams; end
|
|
273
273
|
|
|
274
274
|
class RadarOptions < ::Stripe::RequestParams
|
|
275
|
-
# A [Radar Session](https://stripe.com/
|
|
275
|
+
# 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.
|
|
276
276
|
attr_accessor :session
|
|
277
277
|
|
|
278
278
|
def initialize(session: nil)
|
|
@@ -433,7 +433,7 @@ module Stripe
|
|
|
433
433
|
attr_accessor :link
|
|
434
434
|
# If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
|
|
435
435
|
attr_accessor :mb_way
|
|
436
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
436
|
+
# 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
437
|
attr_accessor :metadata
|
|
438
438
|
# If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
|
|
439
439
|
attr_accessor :mobilepay
|
|
@@ -465,7 +465,7 @@ module Stripe
|
|
|
465
465
|
attr_accessor :promptpay
|
|
466
466
|
# If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
|
|
467
467
|
attr_accessor :qris
|
|
468
|
-
# Options to configure Radar. See [Radar Session](https://stripe.com/
|
|
468
|
+
# Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.
|
|
469
469
|
attr_accessor :radar_options
|
|
470
470
|
# If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
|
|
471
471
|
attr_accessor :rechnung
|
|
@@ -678,7 +678,7 @@ module Stripe
|
|
|
678
678
|
attr_accessor :line2
|
|
679
679
|
# ZIP or postal code.
|
|
680
680
|
attr_accessor :postal_code
|
|
681
|
-
# State, county, province, or region.
|
|
681
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
682
682
|
attr_accessor :state
|
|
683
683
|
|
|
684
684
|
def initialize(
|
|
@@ -722,7 +722,7 @@ module Stripe
|
|
|
722
722
|
attr_accessor :return_url
|
|
723
723
|
# Indicates that you intend to make future payments with this ConfirmationToken's payment method.
|
|
724
724
|
#
|
|
725
|
-
# The presence of this property will [attach the payment method](https://stripe.com/
|
|
725
|
+
# 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.
|
|
726
726
|
attr_accessor :setup_future_usage
|
|
727
727
|
# Shipping information for this ConfirmationToken.
|
|
728
728
|
attr_accessor :shipping
|
|
@@ -4,13 +4,13 @@
|
|
|
4
4
|
module Stripe
|
|
5
5
|
module TestHelpers
|
|
6
6
|
class CustomerFundCashBalanceParams < ::Stripe::RequestParams
|
|
7
|
-
# Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/
|
|
7
|
+
# Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).
|
|
8
8
|
attr_accessor :amount
|
|
9
9
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
10
10
|
attr_accessor :currency
|
|
11
11
|
# Specifies which fields in the response should be expanded.
|
|
12
12
|
attr_accessor :expand
|
|
13
|
-
# A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://stripe.com/
|
|
13
|
+
# A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://docs.stripe.com/payments/customer-balance/reconciliation) applies to different user inputs.
|
|
14
14
|
attr_accessor :reference
|
|
15
15
|
|
|
16
16
|
def initialize(amount: nil, currency: nil, expand: nil, reference: nil)
|