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
|
@@ -9,11 +9,11 @@ module Stripe
|
|
|
9
9
|
# appropriate sub-resource: `document`, `id_number`, `selfie`.
|
|
10
10
|
#
|
|
11
11
|
# Each VerificationReport contains a copy of any data collected by the user as well as
|
|
12
|
-
# reference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/
|
|
12
|
+
# reference IDs which can be used to access collected images through the [FileUpload](https://docs.stripe.com/api/files)
|
|
13
13
|
# API. To configure and create VerificationReports, use the
|
|
14
|
-
# [VerificationSession](https://stripe.com/
|
|
14
|
+
# [VerificationSession](https://docs.stripe.com/api/identity/verification_sessions) API.
|
|
15
15
|
#
|
|
16
|
-
# Related guide: [Accessing verification results](https://stripe.com/
|
|
16
|
+
# Related guide: [Accessing verification results](https://docs.stripe.com/identity/verification-sessions#results).
|
|
17
17
|
class VerificationReport < APIResource
|
|
18
18
|
extend Stripe::APIOperations::List
|
|
19
19
|
|
|
@@ -34,7 +34,7 @@ module Stripe
|
|
|
34
34
|
attr_reader :line2
|
|
35
35
|
# ZIP or postal code.
|
|
36
36
|
attr_reader :postal_code
|
|
37
|
-
# State, county, province, or region.
|
|
37
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
38
38
|
attr_reader :state
|
|
39
39
|
|
|
40
40
|
def self.inner_class_types
|
|
@@ -121,7 +121,7 @@ module Stripe
|
|
|
121
121
|
attr_reader :error
|
|
122
122
|
# Expiration date of the document.
|
|
123
123
|
attr_reader :expiration_date
|
|
124
|
-
# Array of [File](https://stripe.com/
|
|
124
|
+
# Array of [File](https://docs.stripe.com/api/files) ids containing images for this document.
|
|
125
125
|
attr_reader :files
|
|
126
126
|
# First name as it appears in the document.
|
|
127
127
|
attr_reader :first_name
|
|
@@ -250,11 +250,11 @@ module Stripe
|
|
|
250
250
|
class Document < ::Stripe::StripeObject
|
|
251
251
|
# Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
|
|
252
252
|
attr_reader :allowed_types
|
|
253
|
-
# Collect an ID number and perform an [ID number check](https://stripe.com/
|
|
253
|
+
# Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
|
|
254
254
|
attr_reader :require_id_number
|
|
255
255
|
# Disable image uploads, identity document images have to be captured using the device’s camera.
|
|
256
256
|
attr_reader :require_live_capture
|
|
257
|
-
# Capture a face image and perform a [selfie check](https://stripe.com/
|
|
257
|
+
# Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie).
|
|
258
258
|
attr_reader :require_matching_selfie
|
|
259
259
|
|
|
260
260
|
def self.inner_class_types
|
|
@@ -337,11 +337,11 @@ module Stripe
|
|
|
337
337
|
end
|
|
338
338
|
# If selfie was not verified due to being on the blocklist, this is the token of the BlocklistEntry that blocked it
|
|
339
339
|
attr_reader :blocked_by_entry
|
|
340
|
-
# ID of the [File](https://stripe.com/
|
|
340
|
+
# ID of the [File](https://docs.stripe.com/api/files) holding the image of the identity document used in this check.
|
|
341
341
|
attr_reader :document
|
|
342
342
|
# Details on the verification error. Present when status is `unverified`.
|
|
343
343
|
attr_reader :error
|
|
344
|
-
# ID of the [File](https://stripe.com/
|
|
344
|
+
# ID of the [File](https://docs.stripe.com/api/files) holding the image of the selfie used in this check.
|
|
345
345
|
attr_reader :selfie
|
|
346
346
|
# Status of this `selfie` check.
|
|
347
347
|
attr_reader :status
|
|
@@ -13,7 +13,7 @@ module Stripe
|
|
|
13
13
|
# the verification flow. The VerificationSession contains the user's verified data after
|
|
14
14
|
# verification checks are complete.
|
|
15
15
|
#
|
|
16
|
-
# Related guide: [The Verification Sessions API](https://stripe.com/
|
|
16
|
+
# Related guide: [The Verification Sessions API](https://docs.stripe.com/identity/verification-sessions)
|
|
17
17
|
class VerificationSession < APIResource
|
|
18
18
|
extend Stripe::APIOperations::Create
|
|
19
19
|
extend Stripe::APIOperations::List
|
|
@@ -43,11 +43,11 @@ module Stripe
|
|
|
43
43
|
class Document < ::Stripe::StripeObject
|
|
44
44
|
# Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
|
|
45
45
|
attr_reader :allowed_types
|
|
46
|
-
# Collect an ID number and perform an [ID number check](https://stripe.com/
|
|
46
|
+
# Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
|
|
47
47
|
attr_reader :require_id_number
|
|
48
48
|
# Disable image uploads, identity document images have to be captured using the device’s camera.
|
|
49
49
|
attr_reader :require_live_capture
|
|
50
|
-
# Capture a face image and perform a [selfie check](https://stripe.com/
|
|
50
|
+
# Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie).
|
|
51
51
|
attr_reader :require_matching_selfie
|
|
52
52
|
|
|
53
53
|
def self.inner_class_types
|
|
@@ -190,7 +190,7 @@ module Stripe
|
|
|
190
190
|
attr_reader :line2
|
|
191
191
|
# ZIP or postal code.
|
|
192
192
|
attr_reader :postal_code
|
|
193
|
-
# State, county, province, or region.
|
|
193
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
194
194
|
attr_reader :state
|
|
195
195
|
|
|
196
196
|
def self.inner_class_types
|
|
@@ -251,7 +251,7 @@ module Stripe
|
|
|
251
251
|
end
|
|
252
252
|
# A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
|
|
253
253
|
attr_reader :client_reference_id
|
|
254
|
-
# The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/
|
|
254
|
+
# The short-lived client secret used by Stripe.js to [show a verification modal](https://docs.stripe.com/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://docs.stripe.com/identity/verification-sessions#client-secret) to learn more.
|
|
255
255
|
attr_reader :client_secret
|
|
256
256
|
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
257
257
|
attr_reader :created
|
|
@@ -259,11 +259,11 @@ module Stripe
|
|
|
259
259
|
attr_reader :id
|
|
260
260
|
# If present, this property tells you the last error encountered when processing the verification.
|
|
261
261
|
attr_reader :last_error
|
|
262
|
-
# ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/
|
|
262
|
+
# ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://docs.stripe.com/identity/verification-sessions#results)
|
|
263
263
|
attr_reader :last_verification_report
|
|
264
264
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
265
265
|
attr_reader :livemode
|
|
266
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
266
|
+
# 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.
|
|
267
267
|
attr_reader :metadata
|
|
268
268
|
# String representing the object's type. Objects of the same type share the same value.
|
|
269
269
|
attr_reader :object
|
|
@@ -275,15 +275,15 @@ module Stripe
|
|
|
275
275
|
attr_reader :redaction
|
|
276
276
|
# Customer ID
|
|
277
277
|
attr_reader :related_customer
|
|
278
|
-
#
|
|
278
|
+
# The ID of the Account representing a customer.
|
|
279
279
|
attr_reader :related_customer_account
|
|
280
280
|
# Attribute for field related_person
|
|
281
281
|
attr_reader :related_person
|
|
282
|
-
# Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/
|
|
282
|
+
# Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work).
|
|
283
283
|
attr_reader :status
|
|
284
|
-
# The type of [verification check](https://stripe.com/
|
|
284
|
+
# The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed.
|
|
285
285
|
attr_reader :type
|
|
286
|
-
# The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/
|
|
286
|
+
# The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://docs.stripe.com/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.
|
|
287
287
|
attr_reader :url
|
|
288
288
|
# The configuration token of a verification flow from the dashboard.
|
|
289
289
|
attr_reader :verification_flow
|
|
@@ -5,13 +5,13 @@ module Stripe
|
|
|
5
5
|
# Invoices are statements of amounts owed by a customer, and are either
|
|
6
6
|
# generated one-off, or generated periodically from a subscription.
|
|
7
7
|
#
|
|
8
|
-
# They contain [invoice items](https://stripe.com
|
|
8
|
+
# They contain [invoice items](https://api.stripe.com#invoiceitems), and proration adjustments
|
|
9
9
|
# that may be caused by subscription upgrades/downgrades (if necessary).
|
|
10
10
|
#
|
|
11
11
|
# If your invoice is configured to be billed through automatic charges,
|
|
12
12
|
# Stripe automatically finalizes your invoice and attempts payment. Note
|
|
13
13
|
# that finalizing the invoice,
|
|
14
|
-
# [when automatic](https://stripe.com/
|
|
14
|
+
# [when automatic](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection), does
|
|
15
15
|
# not happen immediately as the invoice is created. Stripe waits
|
|
16
16
|
# until one hour after the last webhook was successfully sent (or the last
|
|
17
17
|
# webhook timed out after failing). If you (and the platforms you may have
|
|
@@ -31,9 +31,9 @@ module Stripe
|
|
|
31
31
|
# customer's credit balance which is applied to the next invoice.
|
|
32
32
|
#
|
|
33
33
|
# More details on the customer's credit balance are
|
|
34
|
-
# [here](https://stripe.com/
|
|
34
|
+
# [here](https://docs.stripe.com/billing/customer/balance).
|
|
35
35
|
#
|
|
36
|
-
# Related guide: [Send invoices to customers](https://stripe.com/
|
|
36
|
+
# Related guide: [Send invoices to customers](https://docs.stripe.com/billing/invoices/sending)
|
|
37
37
|
class Invoice < APIResource
|
|
38
38
|
extend Stripe::APIOperations::Create
|
|
39
39
|
include Stripe::APIOperations::Delete
|
|
@@ -93,7 +93,7 @@ module Stripe
|
|
|
93
93
|
end
|
|
94
94
|
# If Stripe disabled automatic tax, this enum describes why.
|
|
95
95
|
attr_reader :disabled_reason
|
|
96
|
-
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/
|
|
96
|
+
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
|
|
97
97
|
attr_reader :enabled
|
|
98
98
|
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
|
99
99
|
attr_reader :liability
|
|
@@ -152,7 +152,7 @@ module Stripe
|
|
|
152
152
|
attr_reader :line2
|
|
153
153
|
# ZIP or postal code.
|
|
154
154
|
attr_reader :postal_code
|
|
155
|
-
# State, county, province, or region.
|
|
155
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
156
156
|
attr_reader :state
|
|
157
157
|
|
|
158
158
|
def self.inner_class_types
|
|
@@ -176,7 +176,7 @@ module Stripe
|
|
|
176
176
|
attr_reader :line2
|
|
177
177
|
# ZIP or postal code.
|
|
178
178
|
attr_reader :postal_code
|
|
179
|
-
# State, county, province, or region.
|
|
179
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
180
180
|
attr_reader :state
|
|
181
181
|
|
|
182
182
|
def self.inner_class_types
|
|
@@ -253,15 +253,15 @@ module Stripe
|
|
|
253
253
|
end
|
|
254
254
|
|
|
255
255
|
class LastFinalizationError < ::Stripe::StripeObject
|
|
256
|
-
# For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/
|
|
256
|
+
# For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one.
|
|
257
257
|
attr_reader :advice_code
|
|
258
258
|
# For card errors, the ID of the failed charge.
|
|
259
259
|
attr_reader :charge
|
|
260
|
-
# For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/
|
|
260
|
+
# For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported.
|
|
261
261
|
attr_reader :code
|
|
262
|
-
# For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/
|
|
262
|
+
# For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one.
|
|
263
263
|
attr_reader :decline_code
|
|
264
|
-
# A URL to more information about the [error code](https://stripe.com/
|
|
264
|
+
# A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported.
|
|
265
265
|
attr_reader :doc_url
|
|
266
266
|
# A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
|
|
267
267
|
attr_reader :message
|
|
@@ -277,17 +277,17 @@ module Stripe
|
|
|
277
277
|
# see the history of payment attempts for a particular session.
|
|
278
278
|
#
|
|
279
279
|
# A PaymentIntent transitions through
|
|
280
|
-
# [multiple statuses](
|
|
280
|
+
# [multiple statuses](/payments/paymentintents/lifecycle)
|
|
281
281
|
# throughout its lifetime as it interfaces with Stripe.js to perform
|
|
282
282
|
# authentication flows and ultimately creates at most one successful charge.
|
|
283
283
|
#
|
|
284
|
-
# Related guide: [Payment Intents API](https://stripe.com/
|
|
284
|
+
# Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents)
|
|
285
285
|
attr_reader :payment_intent
|
|
286
286
|
# PaymentMethod objects represent your customer's payment instruments.
|
|
287
|
-
# You can use them with [PaymentIntents](https://stripe.com/
|
|
287
|
+
# You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to
|
|
288
288
|
# Customer objects to store instrument details for future payments.
|
|
289
289
|
#
|
|
290
|
-
# Related guides: [Payment Methods](https://stripe.com/
|
|
290
|
+
# Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios).
|
|
291
291
|
attr_reader :payment_method
|
|
292
292
|
# If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
|
|
293
293
|
attr_reader :payment_method_type
|
|
@@ -295,7 +295,7 @@ module Stripe
|
|
|
295
295
|
attr_reader :request_log_url
|
|
296
296
|
# A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
|
|
297
297
|
# For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
|
|
298
|
-
# Later, you can use [PaymentIntents](https://stripe.com
|
|
298
|
+
# Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow.
|
|
299
299
|
#
|
|
300
300
|
# Create a SetupIntent when you're ready to collect your customer's payment credentials.
|
|
301
301
|
# Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
|
|
@@ -306,9 +306,9 @@ module Stripe
|
|
|
306
306
|
# For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through
|
|
307
307
|
# [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
|
|
308
308
|
# to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
|
|
309
|
-
# If you use the SetupIntent with a [Customer](https://stripe.com
|
|
309
|
+
# If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer),
|
|
310
310
|
# it automatically attaches the resulting payment method to that Customer after successful setup.
|
|
311
|
-
# We recommend using SetupIntents or [setup_future_usage](https://stripe.com
|
|
311
|
+
# We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on
|
|
312
312
|
# PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.
|
|
313
313
|
#
|
|
314
314
|
# By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
|
|
@@ -384,10 +384,10 @@ module Stripe
|
|
|
384
384
|
@field_remappings = {}
|
|
385
385
|
end
|
|
386
386
|
end
|
|
387
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
387
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
|
|
388
388
|
# *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
|
|
389
389
|
attr_reader :metadata
|
|
390
|
-
# 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/
|
|
390
|
+
# 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).
|
|
391
391
|
attr_reader :pause_collection
|
|
392
392
|
# The subscription that generated this invoice
|
|
393
393
|
attr_reader :subscription
|
|
@@ -406,19 +406,19 @@ module Stripe
|
|
|
406
406
|
attr_reader :billing_cadence_details
|
|
407
407
|
# Details about the quote that generated this invoice
|
|
408
408
|
attr_reader :quote_details
|
|
409
|
+
# Details about the schedule that generated this invoice
|
|
410
|
+
attr_reader :schedule_details
|
|
409
411
|
# Details about the subscription that generated this invoice
|
|
410
412
|
attr_reader :subscription_details
|
|
411
413
|
# The type of parent that generated this invoice
|
|
412
414
|
attr_reader :type
|
|
413
|
-
# Details about the schedule that generated this invoice
|
|
414
|
-
attr_reader :schedule_details
|
|
415
415
|
|
|
416
416
|
def self.inner_class_types
|
|
417
417
|
@inner_class_types = {
|
|
418
418
|
billing_cadence_details: BillingCadenceDetails,
|
|
419
419
|
quote_details: QuoteDetails,
|
|
420
|
-
subscription_details: SubscriptionDetails,
|
|
421
420
|
schedule_details: ScheduleDetails,
|
|
421
|
+
subscription_details: SubscriptionDetails,
|
|
422
422
|
}
|
|
423
423
|
end
|
|
424
424
|
|
|
@@ -484,7 +484,7 @@ module Stripe
|
|
|
484
484
|
end
|
|
485
485
|
# Attribute for field installments
|
|
486
486
|
attr_reader :installments
|
|
487
|
-
# 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/
|
|
487
|
+
# 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.
|
|
488
488
|
attr_reader :request_three_d_secure
|
|
489
489
|
|
|
490
490
|
def self.inner_class_types
|
|
@@ -557,6 +557,35 @@ module Stripe
|
|
|
557
557
|
end
|
|
558
558
|
end
|
|
559
559
|
|
|
560
|
+
class Payto < ::Stripe::StripeObject
|
|
561
|
+
class MandateOptions < ::Stripe::StripeObject
|
|
562
|
+
# The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
|
|
563
|
+
attr_reader :amount
|
|
564
|
+
# Only `maximum` is supported.
|
|
565
|
+
attr_reader :amount_type
|
|
566
|
+
# The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
567
|
+
attr_reader :purpose
|
|
568
|
+
|
|
569
|
+
def self.inner_class_types
|
|
570
|
+
@inner_class_types = {}
|
|
571
|
+
end
|
|
572
|
+
|
|
573
|
+
def self.field_remappings
|
|
574
|
+
@field_remappings = {}
|
|
575
|
+
end
|
|
576
|
+
end
|
|
577
|
+
# Attribute for field mandate_options
|
|
578
|
+
attr_reader :mandate_options
|
|
579
|
+
|
|
580
|
+
def self.inner_class_types
|
|
581
|
+
@inner_class_types = { mandate_options: MandateOptions }
|
|
582
|
+
end
|
|
583
|
+
|
|
584
|
+
def self.field_remappings
|
|
585
|
+
@field_remappings = {}
|
|
586
|
+
end
|
|
587
|
+
end
|
|
588
|
+
|
|
560
589
|
class Pix < ::Stripe::StripeObject
|
|
561
590
|
# Determines if the amount includes the IOF tax.
|
|
562
591
|
attr_reader :amount_includes_iof
|
|
@@ -667,6 +696,8 @@ module Stripe
|
|
|
667
696
|
attr_reader :id_bank_transfer
|
|
668
697
|
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
|
669
698
|
attr_reader :konbini
|
|
699
|
+
# If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
|
|
700
|
+
attr_reader :payto
|
|
670
701
|
# If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
|
|
671
702
|
attr_reader :pix
|
|
672
703
|
# If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
|
|
@@ -684,6 +715,7 @@ module Stripe
|
|
|
684
715
|
customer_balance: CustomerBalance,
|
|
685
716
|
id_bank_transfer: IdBankTransfer,
|
|
686
717
|
konbini: Konbini,
|
|
718
|
+
payto: Payto,
|
|
687
719
|
pix: Pix,
|
|
688
720
|
sepa_debit: SepaDebit,
|
|
689
721
|
upi: Upi,
|
|
@@ -795,7 +827,7 @@ module Stripe
|
|
|
795
827
|
attr_reader :line2
|
|
796
828
|
# ZIP or postal code.
|
|
797
829
|
attr_reader :postal_code
|
|
798
|
-
# State, county, province, or region.
|
|
830
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
799
831
|
attr_reader :state
|
|
800
832
|
|
|
801
833
|
def self.inner_class_types
|
|
@@ -927,7 +959,7 @@ module Stripe
|
|
|
927
959
|
|
|
928
960
|
class TotalTax < ::Stripe::StripeObject
|
|
929
961
|
class TaxRateDetails < ::Stripe::StripeObject
|
|
930
|
-
#
|
|
962
|
+
# ID of the tax rate
|
|
931
963
|
attr_reader :tax_rate
|
|
932
964
|
|
|
933
965
|
def self.inner_class_types
|
|
@@ -983,7 +1015,7 @@ module Stripe
|
|
|
983
1015
|
attr_reader :attempt_count
|
|
984
1016
|
# Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.
|
|
985
1017
|
attr_reader :attempted
|
|
986
|
-
# Controls whether Stripe performs [automatic collection](https://stripe.com/
|
|
1018
|
+
# Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
|
|
987
1019
|
attr_reader :auto_advance
|
|
988
1020
|
# Attribute for field automatic_tax
|
|
989
1021
|
attr_reader :automatic_tax
|
|
@@ -1009,9 +1041,9 @@ module Stripe
|
|
|
1009
1041
|
attr_reader :currency
|
|
1010
1042
|
# Custom fields displayed on the invoice.
|
|
1011
1043
|
attr_reader :custom_fields
|
|
1012
|
-
# The ID of the customer
|
|
1044
|
+
# The ID of the customer to bill.
|
|
1013
1045
|
attr_reader :customer
|
|
1014
|
-
# The ID of the account
|
|
1046
|
+
# The ID of the account representing the customer to bill.
|
|
1015
1047
|
attr_reader :customer_account
|
|
1016
1048
|
# The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
|
|
1017
1049
|
attr_reader :customer_address
|
|
@@ -1047,7 +1079,7 @@ module Stripe
|
|
|
1047
1079
|
attr_reader :ending_balance
|
|
1048
1080
|
# Footer displayed on the invoice.
|
|
1049
1081
|
attr_reader :footer
|
|
1050
|
-
# Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/
|
|
1082
|
+
# Details of the invoice that was cloned. See the [revision documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details.
|
|
1051
1083
|
attr_reader :from_invoice
|
|
1052
1084
|
# The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
|
|
1053
1085
|
attr_reader :hosted_invoice_url
|
|
@@ -1065,7 +1097,7 @@ module Stripe
|
|
|
1065
1097
|
attr_reader :lines
|
|
1066
1098
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
1067
1099
|
attr_reader :livemode
|
|
1068
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
1100
|
+
# 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.
|
|
1069
1101
|
attr_reader :metadata
|
|
1070
1102
|
# The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.
|
|
1071
1103
|
attr_reader :next_payment_attempt
|
|
@@ -1073,7 +1105,7 @@ module Stripe
|
|
|
1073
1105
|
attr_reader :number
|
|
1074
1106
|
# String representing the object's type. Objects of the same type share the same value.
|
|
1075
1107
|
attr_reader :object
|
|
1076
|
-
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/
|
|
1108
|
+
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details.
|
|
1077
1109
|
attr_reader :on_behalf_of
|
|
1078
1110
|
# The parent that generated this invoice
|
|
1079
1111
|
attr_reader :parent
|
|
@@ -1101,7 +1133,7 @@ module Stripe
|
|
|
1101
1133
|
attr_reader :starting_balance
|
|
1102
1134
|
# Extra information about an invoice for the customer's credit card statement.
|
|
1103
1135
|
attr_reader :statement_descriptor
|
|
1104
|
-
# The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/
|
|
1136
|
+
# The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview)
|
|
1105
1137
|
attr_reader :status
|
|
1106
1138
|
# Attribute for field status_transitions
|
|
1107
1139
|
attr_reader :status_transitions
|
|
@@ -1125,7 +1157,7 @@ module Stripe
|
|
|
1125
1157
|
attr_reader :total_pretax_credit_amounts
|
|
1126
1158
|
# The aggregate tax information of all line items.
|
|
1127
1159
|
attr_reader :total_taxes
|
|
1128
|
-
# Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/
|
|
1160
|
+
# Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://docs.stripe.com/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
|
|
1129
1161
|
attr_reader :webhooks_delivered_at
|
|
1130
1162
|
# Always true for a deleted object
|
|
1131
1163
|
attr_reader :deleted
|
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
# frozen_string_literal: true
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
|
-
# Invoice Items represent the component lines of an [invoice](https://stripe.com/
|
|
5
|
+
# Invoice Items represent the component lines of an [invoice](https://docs.stripe.com/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://docs.stripe.com/api/invoices/line_item) within [invoice.lines](https://docs.stripe.com/api/invoices/object#invoice_object-lines).
|
|
6
6
|
#
|
|
7
7
|
# Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined
|
|
8
|
-
# with a [subscription](https://stripe.com/
|
|
8
|
+
# with a [subscription](https://docs.stripe.com/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge
|
|
9
9
|
# or credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges
|
|
10
10
|
# (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.
|
|
11
11
|
#
|
|
12
|
-
# Related guides: [Integrate with the Invoicing API](https://stripe.com/
|
|
12
|
+
# Related guides: [Integrate with the Invoicing API](https://docs.stripe.com/invoicing/integration), [Subscription Invoices](https://docs.stripe.com/billing/invoices/subscription#adding-upcoming-invoice-items).
|
|
13
13
|
class InvoiceItem < APIResource
|
|
14
14
|
extend Stripe::APIOperations::Create
|
|
15
15
|
include Stripe::APIOperations::Delete
|
|
@@ -91,19 +91,19 @@ module Stripe
|
|
|
91
91
|
attr_reader :license_fee_subscription_details
|
|
92
92
|
# Details about the rate card subscription that generated this invoice item
|
|
93
93
|
attr_reader :rate_card_subscription_details
|
|
94
|
+
# Details about the subscription schedule that generated this invoice item
|
|
95
|
+
attr_reader :schedule_details
|
|
94
96
|
# Details about the subscription that generated this invoice item
|
|
95
97
|
attr_reader :subscription_details
|
|
96
98
|
# The type of parent that generated this invoice item
|
|
97
99
|
attr_reader :type
|
|
98
|
-
# Details about the subscription schedule that generated this invoice item
|
|
99
|
-
attr_reader :schedule_details
|
|
100
100
|
|
|
101
101
|
def self.inner_class_types
|
|
102
102
|
@inner_class_types = {
|
|
103
103
|
license_fee_subscription_details: LicenseFeeSubscriptionDetails,
|
|
104
104
|
rate_card_subscription_details: RateCardSubscriptionDetails,
|
|
105
|
-
subscription_details: SubscriptionDetails,
|
|
106
105
|
schedule_details: ScheduleDetails,
|
|
106
|
+
subscription_details: SubscriptionDetails,
|
|
107
107
|
}
|
|
108
108
|
end
|
|
109
109
|
|
|
@@ -230,9 +230,9 @@ module Stripe
|
|
|
230
230
|
attr_reader :amount
|
|
231
231
|
# 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).
|
|
232
232
|
attr_reader :currency
|
|
233
|
-
# The ID of the customer
|
|
233
|
+
# The ID of the customer to bill for this invoice item.
|
|
234
234
|
attr_reader :customer
|
|
235
|
-
# The ID of the account
|
|
235
|
+
# The ID of the account to bill for this invoice item.
|
|
236
236
|
attr_reader :customer_account
|
|
237
237
|
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
238
238
|
attr_reader :date
|
|
@@ -250,7 +250,7 @@ module Stripe
|
|
|
250
250
|
attr_reader :livemode
|
|
251
251
|
# The margins which apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
|
|
252
252
|
attr_reader :margins
|
|
253
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
253
|
+
# 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.
|
|
254
254
|
attr_reader :metadata
|
|
255
255
|
# The amount after discounts, but before credits and taxes. This field is `null` for `discountable=true` items.
|
|
256
256
|
attr_reader :net_amount
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
# frozen_string_literal: true
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
|
-
# Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/
|
|
5
|
+
# Invoice Line Items represent the individual lines within an [invoice](https://docs.stripe.com/api/invoices) and only exist within the context of an invoice.
|
|
6
6
|
#
|
|
7
|
-
# Each line item is backed by either an [invoice item](https://stripe.com/
|
|
7
|
+
# Each line item is backed by either an [invoice item](https://docs.stripe.com/api/invoiceitems) or a [subscription item](https://docs.stripe.com/api/subscription_items).
|
|
8
8
|
class InvoiceLineItem < APIResource
|
|
9
9
|
include Stripe::APIOperations::Save
|
|
10
10
|
|
|
@@ -196,20 +196,20 @@ module Stripe
|
|
|
196
196
|
attr_reader :license_fee_subscription_details
|
|
197
197
|
# Details about the rate card subscription that generated this line item
|
|
198
198
|
attr_reader :rate_card_subscription_details
|
|
199
|
+
# Details about the subscription schedule that generated this line item
|
|
200
|
+
attr_reader :schedule_details
|
|
199
201
|
# Details about the subscription item that generated this line item
|
|
200
202
|
attr_reader :subscription_item_details
|
|
201
203
|
# The type of parent that generated this line item
|
|
202
204
|
attr_reader :type
|
|
203
|
-
# Details about the subscription schedule that generated this line item
|
|
204
|
-
attr_reader :schedule_details
|
|
205
205
|
|
|
206
206
|
def self.inner_class_types
|
|
207
207
|
@inner_class_types = {
|
|
208
208
|
invoice_item_details: InvoiceItemDetails,
|
|
209
209
|
license_fee_subscription_details: LicenseFeeSubscriptionDetails,
|
|
210
210
|
rate_card_subscription_details: RateCardSubscriptionDetails,
|
|
211
|
-
subscription_item_details: SubscriptionItemDetails,
|
|
212
211
|
schedule_details: ScheduleDetails,
|
|
212
|
+
subscription_item_details: SubscriptionItemDetails,
|
|
213
213
|
}
|
|
214
214
|
end
|
|
215
215
|
|
|
@@ -344,7 +344,7 @@ module Stripe
|
|
|
344
344
|
|
|
345
345
|
class Tax < ::Stripe::StripeObject
|
|
346
346
|
class TaxRateDetails < ::Stripe::StripeObject
|
|
347
|
-
#
|
|
347
|
+
# ID of the tax rate
|
|
348
348
|
attr_reader :tax_rate
|
|
349
349
|
|
|
350
350
|
def self.inner_class_types
|
|
@@ -398,7 +398,7 @@ module Stripe
|
|
|
398
398
|
attr_reader :margin_amounts
|
|
399
399
|
# The margins applied to the line item. When set, the `default_margins` on the invoice do not apply to the line item. Use `expand[]=margins` to expand each margin.
|
|
400
400
|
attr_reader :margins
|
|
401
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
401
|
+
# 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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
|
|
402
402
|
attr_reader :metadata
|
|
403
403
|
# String representing the object's type. Objects of the same type share the same value.
|
|
404
404
|
attr_reader :object
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
module Stripe
|
|
5
5
|
# Invoice Payments represent payments made against invoices. Invoice Payments can
|
|
6
6
|
# be accessed in two ways:
|
|
7
|
-
# 1. By expanding the `payments` field on the [Invoice](https://stripe.com
|
|
7
|
+
# 1. By expanding the `payments` field on the [Invoice](https://api.stripe.com#invoice) resource.
|
|
8
8
|
# 2. By using the Invoice Payment retrieve and list endpoints.
|
|
9
9
|
#
|
|
10
10
|
# Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices.
|
|
@@ -18,7 +18,7 @@ module Stripe
|
|
|
18
18
|
attr_reader :id
|
|
19
19
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
20
20
|
attr_reader :livemode
|
|
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.
|
|
22
22
|
attr_reader :metadata
|
|
23
23
|
# A brief description of the template, hidden from customers
|
|
24
24
|
attr_reader :nickname
|