stripe 18.1.0.pre.alpha.4 → 18.2.0.pre.alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/data/ca-certificates.crt +682 -518
- data/lib/stripe/api_requestor.rb +2 -0
- data/lib/stripe/api_version.rb +1 -1
- data/lib/stripe/errors.rb +3 -0
- data/lib/stripe/event_types.rb +56 -0
- data/lib/stripe/events/v2_core_health_api_error_firing_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_api_error_resolved_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_api_latency_firing_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_api_latency_resolved_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_payment_method_error_firing_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_payment_method_error_resolved_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_sepa_debit_delayed_firing_event.rb +58 -0
- data/lib/stripe/events/v2_core_health_sepa_debit_delayed_resolved_event.rb +60 -0
- data/lib/stripe/events/v2_money_management_payout_method_created_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_canceled_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_created_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_errored_event.rb +65 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_funds_not_received_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_matched_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_not_found_event.rb +38 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_settled_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_split_canceled_event.rb +61 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_split_created_event.rb +61 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_split_settled_event.rb +61 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_submitted_event.rb +44 -0
- data/lib/stripe/object_types.rb +6 -0
- data/lib/stripe/params/account_create_params.rb +50 -28
- data/lib/stripe/params/account_external_account_create_params.rb +2 -2
- data/lib/stripe/params/account_external_account_update_params.rb +2 -2
- data/lib/stripe/params/account_notice_update_params.rb +1 -1
- data/lib/stripe/params/account_person_create_params.rb +10 -10
- data/lib/stripe/params/account_person_update_params.rb +10 -10
- data/lib/stripe/params/account_session_create_params.rb +17 -0
- data/lib/stripe/params/account_update_params.rb +49 -27
- data/lib/stripe/params/application_fee_refund_create_params.rb +1 -1
- data/lib/stripe/params/application_fee_refund_update_params.rb +1 -1
- data/lib/stripe/params/balance_transfer_create_params.rb +1 -1
- data/lib/stripe/params/billing/credit_balance_summary_retrieve_params.rb +2 -2
- data/lib/stripe/params/billing/credit_balance_transaction_list_params.rb +2 -2
- data/lib/stripe/params/billing/credit_grant_create_params.rb +2 -2
- data/lib/stripe/params/billing/credit_grant_list_params.rb +1 -1
- data/lib/stripe/params/billing/meter_event_create_params.rb +1 -1
- data/lib/stripe/params/billing_portal/configuration_create_params.rb +7 -3
- data/lib/stripe/params/billing_portal/configuration_update_params.rb +7 -3
- data/lib/stripe/params/billing_portal/session_create_params.rb +7 -7
- data/lib/stripe/params/charge_capture_params.rb +9 -9
- data/lib/stripe/params/charge_create_params.rb +12 -12
- data/lib/stripe/params/charge_search_params.rb +1 -1
- data/lib/stripe/params/charge_update_params.rb +10 -10
- data/lib/stripe/params/checkout/session_create_params.rb +53 -41
- data/lib/stripe/params/checkout/session_update_params.rb +27 -15
- data/lib/stripe/params/climate/order_create_params.rb +1 -1
- data/lib/stripe/params/climate/order_update_params.rb +1 -1
- data/lib/stripe/params/confirmation_token_create_params.rb +6 -6
- data/lib/stripe/params/coupon_create_params.rb +1 -1
- data/lib/stripe/params/coupon_update_params.rb +1 -1
- data/lib/stripe/params/credit_note_create_params.rb +1 -1
- data/lib/stripe/params/credit_note_list_params.rb +1 -1
- data/lib/stripe/params/credit_note_list_preview_line_items_params.rb +1 -1
- data/lib/stripe/params/credit_note_preview_lines_list_params.rb +1 -1
- data/lib/stripe/params/credit_note_preview_params.rb +1 -1
- data/lib/stripe/params/credit_note_update_params.rb +1 -1
- data/lib/stripe/params/customer_balance_transaction_create_params.rb +2 -2
- data/lib/stripe/params/customer_balance_transaction_list_params.rb +11 -1
- data/lib/stripe/params/customer_balance_transaction_update_params.rb +1 -1
- data/lib/stripe/params/customer_cash_balance_update_params.rb +1 -1
- data/lib/stripe/params/customer_create_params.rb +5 -5
- data/lib/stripe/params/customer_fund_cash_balance_params.rb +2 -2
- data/lib/stripe/params/customer_payment_source_create_params.rb +2 -2
- data/lib/stripe/params/customer_payment_source_update_params.rb +2 -2
- data/lib/stripe/params/customer_search_params.rb +1 -1
- data/lib/stripe/params/customer_update_params.rb +7 -7
- data/lib/stripe/params/delegated_checkout/requested_session_confirm_params.rb +84 -1
- data/lib/stripe/params/dispute_update_params.rb +3 -3
- data/lib/stripe/params/external_account_create_params.rb +2 -2
- data/lib/stripe/params/external_account_update_params.rb +2 -2
- data/lib/stripe/params/file_create_params.rb +3 -3
- data/lib/stripe/params/file_link_create_params.rb +1 -1
- data/lib/stripe/params/file_link_update_params.rb +1 -1
- data/lib/stripe/params/financial_connections/account_list_params.rb +3 -3
- data/lib/stripe/params/financial_connections/session_create_params.rb +3 -3
- data/lib/stripe/params/forwarding/request_create_params.rb +1 -1
- data/lib/stripe/params/identity/verification_session_create_params.rb +6 -6
- data/lib/stripe/params/identity/verification_session_list_params.rb +3 -3
- data/lib/stripe/params/identity/verification_session_update_params.rb +5 -5
- data/lib/stripe/params/invoice_add_lines_params.rb +21 -9
- data/lib/stripe/params/invoice_attach_payment_params.rb +1 -1
- data/lib/stripe/params/invoice_create_params.rb +37 -13
- data/lib/stripe/params/invoice_create_preview_params.rb +60 -60
- data/lib/stripe/params/invoice_finalize_invoice_params.rb +1 -1
- data/lib/stripe/params/invoice_item_create_params.rb +8 -8
- data/lib/stripe/params/invoice_item_list_params.rb +2 -2
- data/lib/stripe/params/invoice_item_update_params.rb +6 -6
- data/lib/stripe/params/invoice_line_item_update_params.rb +20 -8
- data/lib/stripe/params/invoice_list_params.rb +2 -2
- data/lib/stripe/params/invoice_remove_lines_params.rb +1 -1
- data/lib/stripe/params/invoice_search_params.rb +1 -1
- data/lib/stripe/params/invoice_update_lines_params.rb +21 -9
- data/lib/stripe/params/invoice_update_params.rb +34 -10
- data/lib/stripe/params/issuing/authorization_approve_params.rb +2 -2
- data/lib/stripe/params/issuing/authorization_capture_params.rb +1 -1
- data/lib/stripe/params/issuing/authorization_create_params.rb +5 -5
- data/lib/stripe/params/issuing/authorization_decline_params.rb +1 -1
- data/lib/stripe/params/issuing/authorization_finalize_amount_params.rb +1 -1
- data/lib/stripe/params/issuing/authorization_increment_params.rb +2 -2
- data/lib/stripe/params/issuing/authorization_reverse_params.rb +1 -1
- data/lib/stripe/params/issuing/authorization_update_params.rb +1 -1
- data/lib/stripe/params/issuing/card_create_params.rb +7 -7
- data/lib/stripe/params/issuing/card_list_params.rb +34 -1
- data/lib/stripe/params/issuing/card_update_params.rb +6 -6
- data/lib/stripe/params/issuing/cardholder_create_params.rb +11 -11
- data/lib/stripe/params/issuing/cardholder_update_params.rb +10 -10
- data/lib/stripe/params/issuing/credit_underwriting_record_correct_params.rb +5 -5
- data/lib/stripe/params/issuing/credit_underwriting_record_create_from_application_params.rb +1 -1
- data/lib/stripe/params/issuing/credit_underwriting_record_create_from_proactive_review_params.rb +5 -5
- data/lib/stripe/params/issuing/credit_underwriting_record_report_decision_params.rb +4 -4
- data/lib/stripe/params/issuing/dispute_create_params.rb +2 -2
- data/lib/stripe/params/issuing/dispute_submit_params.rb +1 -1
- data/lib/stripe/params/issuing/dispute_update_params.rb +2 -2
- data/lib/stripe/params/issuing/personalization_design_create_params.rb +1 -1
- data/lib/stripe/params/issuing/personalization_design_update_params.rb +1 -1
- data/lib/stripe/params/issuing/program_update_params.rb +1 -1
- data/lib/stripe/params/issuing/transaction_create_force_capture_params.rb +2 -2
- data/lib/stripe/params/issuing/transaction_create_unlinked_refund_params.rb +2 -2
- data/lib/stripe/params/issuing/transaction_refund_params.rb +1 -1
- data/lib/stripe/params/issuing/transaction_update_params.rb +1 -1
- data/lib/stripe/params/mandate_list_params.rb +1 -1
- data/lib/stripe/params/margin_create_params.rb +1 -1
- data/lib/stripe/params/margin_update_params.rb +1 -1
- data/lib/stripe/params/order_create_params.rb +12 -12
- data/lib/stripe/params/order_update_params.rb +12 -12
- data/lib/stripe/params/payment_intent_apply_customer_balance_params.rb +1 -1
- data/lib/stripe/params/payment_intent_capture_params.rb +18 -18
- data/lib/stripe/params/payment_intent_confirm_params.rb +43 -39
- data/lib/stripe/params/payment_intent_create_params.rb +61 -57
- data/lib/stripe/params/payment_intent_decrement_authorization_params.rb +4 -4
- data/lib/stripe/params/payment_intent_increment_authorization_params.rb +10 -10
- data/lib/stripe/params/payment_intent_list_params.rb +1 -1
- data/lib/stripe/params/payment_intent_search_params.rb +1 -1
- data/lib/stripe/params/payment_intent_update_params.rb +40 -40
- data/lib/stripe/params/payment_link_create_params.rb +32 -20
- data/lib/stripe/params/payment_link_update_params.rb +9 -9
- data/lib/stripe/params/payment_method_attach_params.rb +1 -1
- data/lib/stripe/params/payment_method_configuration_create_params.rb +40 -40
- data/lib/stripe/params/payment_method_configuration_update_params.rb +40 -40
- data/lib/stripe/params/payment_method_create_params.rb +4 -4
- data/lib/stripe/params/payment_method_update_params.rb +2 -2
- data/lib/stripe/params/payment_record_report_payment_attempt_informational_params.rb +2 -2
- data/lib/stripe/params/payment_record_report_payment_attempt_params.rb +3 -3
- data/lib/stripe/params/payment_record_report_payment_params.rb +4 -4
- data/lib/stripe/params/payment_record_report_refund_params.rb +3 -3
- data/lib/stripe/params/payout_create_params.rb +1 -1
- data/lib/stripe/params/payout_reverse_params.rb +1 -1
- data/lib/stripe/params/payout_update_params.rb +1 -1
- data/lib/stripe/params/plan_create_params.rb +4 -4
- data/lib/stripe/params/plan_update_params.rb +2 -2
- data/lib/stripe/params/price_create_params.rb +6 -6
- data/lib/stripe/params/price_search_params.rb +1 -1
- data/lib/stripe/params/price_update_params.rb +3 -3
- data/lib/stripe/params/product_create_params.rb +21 -8
- data/lib/stripe/params/product_feature_create_params.rb +1 -1
- data/lib/stripe/params/product_list_params.rb +1 -1
- data/lib/stripe/params/product_search_params.rb +1 -1
- data/lib/stripe/params/product_update_params.rb +18 -5
- data/lib/stripe/params/promotion_code_create_params.rb +3 -3
- data/lib/stripe/params/promotion_code_list_params.rb +1 -1
- data/lib/stripe/params/promotion_code_update_params.rb +1 -1
- data/lib/stripe/params/quote_create_params.rb +14 -14
- data/lib/stripe/params/quote_list_params.rb +2 -2
- data/lib/stripe/params/quote_update_params.rb +14 -14
- data/lib/stripe/params/radar/value_list_create_params.rb +1 -1
- data/lib/stripe/params/radar/value_list_update_params.rb +1 -1
- data/lib/stripe/params/refund_create_params.rb +2 -2
- data/lib/stripe/params/refund_update_params.rb +1 -1
- data/lib/stripe/params/reporting/report_run_create_params.rb +2 -2
- data/lib/stripe/params/setup_intent_confirm_params.rb +6 -6
- data/lib/stripe/params/setup_intent_create_params.rb +12 -12
- data/lib/stripe/params/setup_intent_update_params.rb +8 -8
- data/lib/stripe/params/shared_payment/granted_token_create_params.rb +47 -0
- data/lib/stripe/params/shared_payment/granted_token_retrieve_params.rb +15 -0
- data/lib/stripe/params/shared_payment/granted_token_update_params.rb +15 -0
- data/lib/stripe/params/shipping_rate_create_params.rb +2 -2
- data/lib/stripe/params/shipping_rate_update_params.rb +1 -1
- data/lib/stripe/params/source_create_params.rb +3 -3
- data/lib/stripe/params/source_update_params.rb +3 -3
- data/lib/stripe/params/subscription_create_params.rb +51 -27
- data/lib/stripe/params/subscription_item_create_params.rb +15 -15
- data/lib/stripe/params/subscription_item_delete_params.rb +2 -2
- data/lib/stripe/params/subscription_item_update_params.rb +15 -15
- data/lib/stripe/params/subscription_list_params.rb +3 -3
- data/lib/stripe/params/subscription_resume_params.rb +2 -2
- data/lib/stripe/params/subscription_schedule_amend_params.rb +10 -10
- data/lib/stripe/params/subscription_schedule_create_params.rb +31 -31
- data/lib/stripe/params/subscription_schedule_update_params.rb +31 -31
- data/lib/stripe/params/subscription_search_params.rb +1 -1
- data/lib/stripe/params/subscription_update_params.rb +49 -25
- data/lib/stripe/params/tax/association_find_params.rb +1 -1
- data/lib/stripe/params/tax/calculation_create_params.rb +7 -7
- data/lib/stripe/params/tax/settings_update_params.rb +1 -1
- data/lib/stripe/params/tax/transaction_create_from_calculation_params.rb +1 -1
- data/lib/stripe/params/tax/transaction_create_reversal_params.rb +9 -9
- data/lib/stripe/params/tax_id_create_params.rb +2 -2
- data/lib/stripe/params/tax_id_list_params.rb +2 -2
- data/lib/stripe/params/tax_rate_create_params.rb +1 -1
- data/lib/stripe/params/tax_rate_update_params.rb +1 -1
- data/lib/stripe/params/terminal/location_create_params.rb +2 -2
- data/lib/stripe/params/terminal/location_update_params.rb +2 -2
- data/lib/stripe/params/terminal/reader_collect_inputs_params.rb +1 -1
- data/lib/stripe/params/terminal/reader_create_params.rb +1 -1
- data/lib/stripe/params/terminal/reader_refund_payment_params.rb +1 -1
- data/lib/stripe/params/terminal/reader_set_reader_display_params.rb +3 -3
- data/lib/stripe/params/terminal/reader_update_params.rb +1 -1
- data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +6 -6
- data/lib/stripe/params/test_helpers/customer_fund_cash_balance_params.rb +2 -2
- data/lib/stripe/params/test_helpers/issuing/authorization_capture_params.rb +1 -1
- data/lib/stripe/params/test_helpers/issuing/authorization_create_params.rb +5 -5
- data/lib/stripe/params/test_helpers/issuing/authorization_finalize_amount_params.rb +1 -1
- data/lib/stripe/params/test_helpers/issuing/authorization_increment_params.rb +2 -2
- data/lib/stripe/params/test_helpers/issuing/authorization_reverse_params.rb +1 -1
- data/lib/stripe/params/test_helpers/issuing/transaction_create_force_capture_params.rb +2 -2
- data/lib/stripe/params/test_helpers/issuing/transaction_create_unlinked_refund_params.rb +2 -2
- data/lib/stripe/params/test_helpers/issuing/transaction_refund_params.rb +1 -1
- data/lib/stripe/params/test_helpers/shared_payment/granted_token_create_params.rb +49 -0
- data/lib/stripe/params/test_helpers/shared_payment/granted_token_update_params.rb +17 -0
- data/lib/stripe/params/test_helpers/treasury/received_credit_create_params.rb +1 -1
- data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +1 -1
- data/lib/stripe/params/token_create_params.rb +22 -22
- data/lib/stripe/params/topup_create_params.rb +2 -2
- data/lib/stripe/params/topup_update_params.rb +1 -1
- data/lib/stripe/params/transfer_create_params.rb +3 -3
- data/lib/stripe/params/transfer_reversal_create_params.rb +1 -1
- data/lib/stripe/params/transfer_reversal_update_params.rb +1 -1
- data/lib/stripe/params/transfer_update_params.rb +1 -1
- data/lib/stripe/params/treasury/credit_reversal_create_params.rb +1 -1
- data/lib/stripe/params/treasury/debit_reversal_create_params.rb +1 -1
- data/lib/stripe/params/treasury/financial_account_create_params.rb +1 -1
- data/lib/stripe/params/treasury/financial_account_update_params.rb +1 -1
- data/lib/stripe/params/treasury/inbound_transfer_create_params.rb +2 -2
- data/lib/stripe/params/treasury/outbound_payment_create_params.rb +5 -5
- data/lib/stripe/params/treasury/outbound_transfer_create_params.rb +3 -3
- data/lib/stripe/params/treasury/received_credit_create_params.rb +1 -1
- data/lib/stripe/params/treasury/received_debit_create_params.rb +1 -1
- data/lib/stripe/params/v2/billing/intent_create_params.rb +110 -40
- data/lib/stripe/params/v2/core/account_create_params.rb +36 -24
- data/lib/stripe/params/v2/core/account_link_create_params.rb +5 -5
- data/lib/stripe/params/v2/core/account_token_create_params.rb +8 -8
- data/lib/stripe/params/v2/core/account_update_params.rb +41 -29
- data/lib/stripe/params/v2/core/accounts/person_create_params.rb +5 -5
- data/lib/stripe/params/v2/core/accounts/person_token_create_params.rb +5 -5
- data/lib/stripe/params/v2/core/accounts/person_update_params.rb +5 -5
- data/lib/stripe/params/v2/core/claimable_sandbox_create_params.rb +1 -1
- data/lib/stripe/params/v2/iam/api_key_create_params.rb +51 -0
- data/lib/stripe/params/v2/iam/api_key_expire_params.rb +10 -0
- data/lib/stripe/params/v2/iam/api_key_list_params.rb +20 -0
- data/lib/stripe/params/v2/iam/api_key_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/iam/api_key_rotate_params.rb +46 -0
- data/lib/stripe/params/v2/iam/api_key_update_params.rb +20 -0
- data/lib/stripe/params/v2/money_management/financial_account_list_params.rb +4 -1
- data/lib/stripe/params/v2/money_management/outbound_payment_create_params.rb +4 -1
- data/lib/stripe/params/v2/money_management/outbound_payment_quote_create_params.rb +4 -1
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_cancel_params.rb +10 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_create_params.rb +46 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_submit_params.rb +10 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_update_params.rb +31 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intents/split_cancel_params.rb +12 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intents/split_create_params.rb +39 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intents/split_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/tax/manual_rule_create_params.rb +94 -0
- data/lib/stripe/params/v2/tax/manual_rule_deactivate_params.rb +10 -0
- data/lib/stripe/params/v2/tax/manual_rule_list_params.rb +17 -0
- data/lib/stripe/params/v2/tax/manual_rule_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/tax/manual_rule_update_params.rb +94 -0
- data/lib/stripe/params/webhook_endpoint_create_params.rb +1 -1
- data/lib/stripe/params/webhook_endpoint_update_params.rb +1 -1
- data/lib/stripe/params.rb +24 -0
- data/lib/stripe/resources/account.rb +27 -27
- data/lib/stripe/resources/account_link.rb +1 -1
- data/lib/stripe/resources/account_notice.rb +6 -6
- data/lib/stripe/resources/account_session.rb +5 -5
- data/lib/stripe/resources/application_fee_refund.rb +2 -2
- data/lib/stripe/resources/apps/secret.rb +1 -1
- data/lib/stripe/resources/balance.rb +2 -2
- data/lib/stripe/resources/balance_settings.rb +1 -1
- data/lib/stripe/resources/balance_transaction.rb +1 -1
- data/lib/stripe/resources/balance_transfer.rb +3 -3
- data/lib/stripe/resources/bank_account.rb +10 -10
- data/lib/stripe/resources/billing/alert.rb +2 -2
- data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -2
- data/lib/stripe/resources/billing/credit_balance_transaction.rb +2 -2
- data/lib/stripe/resources/billing/credit_grant.rb +3 -3
- data/lib/stripe/resources/billing/meter_event.rb +1 -1
- data/lib/stripe/resources/billing_portal/configuration.rb +5 -3
- data/lib/stripe/resources/billing_portal/session.rb +6 -6
- data/lib/stripe/resources/capability.rb +16 -16
- data/lib/stripe/resources/capital/financing_offer.rb +2 -2
- data/lib/stripe/resources/capital/financing_summary.rb +7 -4
- data/lib/stripe/resources/card.rb +2 -2
- data/lib/stripe/resources/cash_balance.rb +2 -2
- data/lib/stripe/resources/charge.rb +47 -35
- data/lib/stripe/resources/checkout/session.rb +19 -19
- data/lib/stripe/resources/climate/order.rb +1 -1
- data/lib/stripe/resources/confirmation_token.rb +11 -11
- data/lib/stripe/resources/coupon.rb +3 -3
- data/lib/stripe/resources/credit_note.rb +5 -5
- data/lib/stripe/resources/credit_note_line_item.rb +1 -1
- data/lib/stripe/resources/customer.rb +8 -8
- data/lib/stripe/resources/customer_balance_transaction.rb +6 -6
- data/lib/stripe/resources/customer_cash_balance_transaction.rb +10 -10
- data/lib/stripe/resources/delegated_checkout/requested_session.rb +63 -10
- data/lib/stripe/resources/discount.rb +5 -5
- data/lib/stripe/resources/dispute.rb +5 -5
- data/lib/stripe/resources/entitlements/active_entitlement.rb +1 -1
- data/lib/stripe/resources/event.rb +1 -1
- data/lib/stripe/resources/exchange_rate.rb +2 -2
- data/lib/stripe/resources/file.rb +4 -4
- data/lib/stripe/resources/file_link.rb +1 -1
- data/lib/stripe/resources/financial_connections/account.rb +3 -3
- data/lib/stripe/resources/financial_connections/session.rb +2 -2
- data/lib/stripe/resources/forwarding/request.rb +1 -1
- data/lib/stripe/resources/funding_instructions.rb +14 -14
- data/lib/stripe/resources/identity/blocklist_entry.rb +1 -1
- data/lib/stripe/resources/identity/verification_report.rb +9 -9
- data/lib/stripe/resources/identity/verification_session.rb +11 -11
- data/lib/stripe/resources/invoice.rb +66 -34
- data/lib/stripe/resources/invoice_item.rb +9 -9
- data/lib/stripe/resources/invoice_line_item.rb +7 -7
- data/lib/stripe/resources/invoice_payment.rb +1 -1
- data/lib/stripe/resources/invoice_rendering_template.rb +1 -1
- data/lib/stripe/resources/issuing/authorization.rb +20 -20
- data/lib/stripe/resources/issuing/card.rb +16 -12
- data/lib/stripe/resources/issuing/cardholder.rb +14 -14
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +5 -5
- data/lib/stripe/resources/issuing/dispute.rb +7 -7
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +1 -1
- data/lib/stripe/resources/issuing/personalization_design.rb +1 -1
- data/lib/stripe/resources/issuing/program.rb +1 -1
- data/lib/stripe/resources/issuing/settlement.rb +2 -2
- data/lib/stripe/resources/issuing/token.rb +1 -1
- data/lib/stripe/resources/issuing/transaction.rb +13 -13
- data/lib/stripe/resources/line_item.rb +3 -3
- data/lib/stripe/resources/login_link.rb +1 -1
- data/lib/stripe/resources/margin.rb +1 -1
- data/lib/stripe/resources/order.rb +13 -13
- data/lib/stripe/resources/payment_attempt_record.rb +80 -22
- data/lib/stripe/resources/payment_intent.rb +117 -74
- data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +3 -3
- data/lib/stripe/resources/payment_link.rb +7 -7
- data/lib/stripe/resources/payment_method.rb +13 -13
- data/lib/stripe/resources/payment_method_configuration.rb +4 -4
- data/lib/stripe/resources/payment_method_domain.rb +1 -1
- data/lib/stripe/resources/payment_record.rb +82 -22
- data/lib/stripe/resources/payout.rb +7 -7
- data/lib/stripe/resources/person.rb +23 -23
- data/lib/stripe/resources/plan.rb +5 -5
- data/lib/stripe/resources/price.rb +6 -6
- data/lib/stripe/resources/product.rb +9 -9
- data/lib/stripe/resources/promotion_code.rb +4 -4
- data/lib/stripe/resources/quote.rb +15 -15
- data/lib/stripe/resources/quote_line.rb +5 -5
- data/lib/stripe/resources/quote_preview_invoice.rb +64 -32
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +100 -100
- data/lib/stripe/resources/radar/early_fraud_warning.rb +1 -1
- data/lib/stripe/resources/radar/value_list.rb +2 -2
- data/lib/stripe/resources/radar/value_list_item.rb +1 -1
- data/lib/stripe/resources/refund.rb +3 -3
- data/lib/stripe/resources/reporting/report_run.rb +3 -3
- data/lib/stripe/resources/reporting/report_type.rb +3 -3
- data/lib/stripe/resources/reversal.rb +4 -4
- data/lib/stripe/resources/review.rb +1 -1
- data/lib/stripe/resources/setup_attempt.rb +17 -17
- data/lib/stripe/resources/setup_intent.rb +19 -19
- data/lib/stripe/resources/shared_payment/granted_token.rb +126 -0
- data/lib/stripe/resources/shipping_rate.rb +3 -3
- data/lib/stripe/resources/sigma/scheduled_query_run.rb +1 -1
- data/lib/stripe/resources/source.rb +8 -8
- data/lib/stripe/resources/source_mandate_notification.rb +3 -3
- data/lib/stripe/resources/subscription.rb +46 -14
- data/lib/stripe/resources/subscription_item.rb +22 -22
- data/lib/stripe/resources/subscription_schedule.rb +101 -101
- data/lib/stripe/resources/tax/association.rb +3 -3
- data/lib/stripe/resources/tax/calculation.rb +12 -12
- data/lib/stripe/resources/tax/calculation_line_item.rb +7 -7
- data/lib/stripe/resources/tax/registration.rb +3 -3
- data/lib/stripe/resources/tax/settings.rb +2 -2
- data/lib/stripe/resources/tax/transaction.rb +9 -9
- data/lib/stripe/resources/tax/transaction_line_item.rb +5 -5
- data/lib/stripe/resources/tax_id.rb +4 -4
- data/lib/stripe/resources/tax_rate.rb +1 -1
- data/lib/stripe/resources/terminal/connection_token.rb +1 -1
- data/lib/stripe/resources/terminal/location.rb +3 -3
- data/lib/stripe/resources/terminal/reader.rb +10 -10
- data/lib/stripe/resources/token.rb +4 -4
- data/lib/stripe/resources/topup.rb +3 -3
- data/lib/stripe/resources/transfer.rb +5 -5
- data/lib/stripe/resources/treasury/credit_reversal.rb +3 -3
- data/lib/stripe/resources/treasury/debit_reversal.rb +3 -3
- data/lib/stripe/resources/treasury/financial_account.rb +1 -1
- data/lib/stripe/resources/treasury/inbound_transfer.rb +5 -5
- data/lib/stripe/resources/treasury/outbound_payment.rb +6 -6
- data/lib/stripe/resources/treasury/outbound_transfer.rb +5 -5
- data/lib/stripe/resources/treasury/received_credit.rb +10 -10
- data/lib/stripe/resources/treasury/received_debit.rb +7 -7
- data/lib/stripe/resources/treasury/transaction.rb +11 -11
- data/lib/stripe/resources/treasury/transaction_entry.rb +11 -11
- data/lib/stripe/resources/v2/billing/intent_action.rb +139 -51
- data/lib/stripe/resources/v2/core/account.rb +174 -289
- data/lib/stripe/resources/v2/core/account_link.rb +11 -11
- data/lib/stripe/resources/v2/core/account_person.rb +10 -10
- data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +21 -1
- data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +23 -1
- data/lib/stripe/resources/v2/iam/api_key.rb +129 -0
- data/lib/stripe/resources/v2/money_management/financial_account.rb +35 -0
- data/lib/stripe/resources/v2/money_management/outbound_payment.rb +2 -0
- data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +2 -0
- data/lib/stripe/resources/v2/money_management/payout_method.rb +20 -0
- data/lib/stripe/resources/v2/money_management/received_credit.rb +2 -0
- data/lib/stripe/resources/v2/payments/settlement_allocation_intent.rb +92 -0
- data/lib/stripe/resources/v2/payments/settlement_allocation_intent_split.rb +78 -0
- data/lib/stripe/resources/v2/tax/manual_rule.rb +115 -0
- data/lib/stripe/resources/webhook_endpoint.rb +1 -1
- data/lib/stripe/resources.rb +19 -0
- data/lib/stripe/services/capital/financing_summary_service.rb +1 -1
- data/lib/stripe/services/payment_method_service.rb +1 -1
- data/lib/stripe/services/shared_payment/granted_token_service.rb +19 -0
- data/lib/stripe/services/shared_payment_service.rb +13 -0
- data/lib/stripe/services/test_helpers/shared_payment/granted_token_service.rb +32 -0
- data/lib/stripe/services/test_helpers/shared_payment_service.rb +15 -0
- data/lib/stripe/services/test_helpers_service.rb +2 -1
- data/lib/stripe/services/v1_services.rb +2 -1
- data/lib/stripe/services/v2/core/account_link_service.rb +1 -1
- data/lib/stripe/services/v2/core/account_service.rb +0 -4
- data/lib/stripe/services/v2/core/accounts/person_service.rb +2 -2
- data/lib/stripe/services/v2/iam/api_key_service.rb +76 -0
- data/lib/stripe/services/v2/iam_service.rb +15 -0
- data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +2 -0
- data/lib/stripe/services/v2/money_management/payout_method_service.rb +2 -0
- data/lib/stripe/services/v2/payment_service.rb +3 -1
- data/lib/stripe/services/v2/payments/settlement_allocation_intent_service.rb +72 -0
- data/lib/stripe/services/v2/payments/settlement_allocation_intents/split_service.rb +45 -0
- data/lib/stripe/services/v2/tax/manual_rule_service.rb +65 -0
- data/lib/stripe/services/v2/tax_service.rb +15 -0
- data/lib/stripe/services/v2_services.rb +3 -1
- data/lib/stripe/services.rb +10 -0
- data/lib/stripe/stripe_object.rb +11 -3
- data/lib/stripe/version.rb +1 -1
- data/rbi/stripe.rbi +6022 -3221
- metadata +55 -2
|
@@ -3,11 +3,11 @@
|
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
5
|
module Issuing
|
|
6
|
-
# When an [issued card](https://stripe.com/
|
|
7
|
-
# object is created. [Authorizations](https://stripe.com/
|
|
6
|
+
# When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization`
|
|
7
|
+
# object is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the
|
|
8
8
|
# purchase to be completed successfully.
|
|
9
9
|
#
|
|
10
|
-
# Related guide: [Issued card authorizations](https://stripe.com/
|
|
10
|
+
# Related guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations)
|
|
11
11
|
class Authorization < APIResource
|
|
12
12
|
extend Gem::Deprecate
|
|
13
13
|
extend Stripe::APIOperations::List
|
|
@@ -173,7 +173,7 @@ module Stripe
|
|
|
173
173
|
end
|
|
174
174
|
|
|
175
175
|
class MerchantData < ::Stripe::StripeObject
|
|
176
|
-
# A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/
|
|
176
|
+
# A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values.
|
|
177
177
|
attr_reader :category
|
|
178
178
|
# The merchant category code for the seller’s business
|
|
179
179
|
attr_reader :category_code
|
|
@@ -237,15 +237,15 @@ module Stripe
|
|
|
237
237
|
@field_remappings = {}
|
|
238
238
|
end
|
|
239
239
|
end
|
|
240
|
-
# The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/
|
|
240
|
+
# The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://docs.stripe.com/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
241
241
|
attr_reader :amount
|
|
242
|
-
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/
|
|
242
|
+
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
243
243
|
attr_reader :amount_details
|
|
244
244
|
# 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).
|
|
245
245
|
attr_reader :currency
|
|
246
|
-
# If set `true`, you may provide [amount](https://stripe.com/
|
|
246
|
+
# If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.
|
|
247
247
|
attr_reader :is_amount_controllable
|
|
248
|
-
# The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/
|
|
248
|
+
# The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
249
249
|
attr_reader :merchant_amount
|
|
250
250
|
# The local currency the merchant is requesting to authorize.
|
|
251
251
|
attr_reader :merchant_currency
|
|
@@ -276,9 +276,9 @@ module Stripe
|
|
|
276
276
|
@field_remappings = {}
|
|
277
277
|
end
|
|
278
278
|
end
|
|
279
|
-
# The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/
|
|
279
|
+
# The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved.
|
|
280
280
|
attr_reader :amount
|
|
281
|
-
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/
|
|
281
|
+
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
282
282
|
attr_reader :amount_details
|
|
283
283
|
# Whether this request was approved.
|
|
284
284
|
attr_reader :approved
|
|
@@ -288,7 +288,7 @@ module Stripe
|
|
|
288
288
|
attr_reader :created
|
|
289
289
|
# 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).
|
|
290
290
|
attr_reader :currency
|
|
291
|
-
# The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/
|
|
291
|
+
# The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
292
292
|
attr_reader :merchant_amount
|
|
293
293
|
# The currency that was collected by the merchant and presented to the cardholder for the authorization. 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).
|
|
294
294
|
attr_reader :merchant_currency
|
|
@@ -311,11 +311,11 @@ module Stripe
|
|
|
311
311
|
end
|
|
312
312
|
|
|
313
313
|
class Treasury < ::Stripe::StripeObject
|
|
314
|
-
# The array of [ReceivedCredits](https://stripe.com/
|
|
314
|
+
# The array of [ReceivedCredits](https://docs.stripe.com/api/treasury/received_credits) associated with this authorization
|
|
315
315
|
attr_reader :received_credits
|
|
316
|
-
# The array of [ReceivedDebits](https://stripe.com/
|
|
316
|
+
# The array of [ReceivedDebits](https://docs.stripe.com/api/treasury/received_debits) associated with this authorization
|
|
317
317
|
attr_reader :received_debits
|
|
318
|
-
# The Treasury [Transaction](https://stripe.com/
|
|
318
|
+
# The Treasury [Transaction](https://docs.stripe.com/api/treasury/transactions) associated with this authorization
|
|
319
319
|
attr_reader :transaction
|
|
320
320
|
|
|
321
321
|
def self.inner_class_types
|
|
@@ -383,7 +383,7 @@ module Stripe
|
|
|
383
383
|
end
|
|
384
384
|
# The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.
|
|
385
385
|
attr_reader :amount
|
|
386
|
-
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/
|
|
386
|
+
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
387
387
|
attr_reader :amount_details
|
|
388
388
|
# Whether the authorization has been approved.
|
|
389
389
|
attr_reader :approved
|
|
@@ -391,7 +391,7 @@ module Stripe
|
|
|
391
391
|
attr_reader :authorization_method
|
|
392
392
|
# List of balance transactions associated with this authorization.
|
|
393
393
|
attr_reader :balance_transactions
|
|
394
|
-
# You can [create physical or virtual cards](https://stripe.com/
|
|
394
|
+
# You can [create physical or virtual cards](https://docs.stripe.com/issuing) that are issued to cardholders.
|
|
395
395
|
attr_reader :card
|
|
396
396
|
# The cardholder to whom this authorization belongs.
|
|
397
397
|
attr_reader :cardholder
|
|
@@ -415,7 +415,7 @@ module Stripe
|
|
|
415
415
|
attr_reader :merchant_currency
|
|
416
416
|
# Attribute for field merchant_data
|
|
417
417
|
attr_reader :merchant_data
|
|
418
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
418
|
+
# 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.
|
|
419
419
|
attr_reader :metadata
|
|
420
420
|
# Details about the authorization, such as identifiers, set by the card network.
|
|
421
421
|
attr_reader :network_data
|
|
@@ -427,11 +427,11 @@ module Stripe
|
|
|
427
427
|
attr_reader :request_history
|
|
428
428
|
# The current status of the authorization in its lifecycle.
|
|
429
429
|
attr_reader :status
|
|
430
|
-
# [Token](https://stripe.com/
|
|
430
|
+
# [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.
|
|
431
431
|
attr_reader :token
|
|
432
|
-
# List of [transactions](https://stripe.com/
|
|
432
|
+
# List of [transactions](https://docs.stripe.com/api/issuing/transactions) associated with this authorization.
|
|
433
433
|
attr_reader :transactions
|
|
434
|
-
# [Treasury](https://stripe.com/
|
|
434
|
+
# [Treasury](https://docs.stripe.com/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://docs.stripe.com/api/treasury/financial_accounts).
|
|
435
435
|
attr_reader :treasury
|
|
436
436
|
# Attribute for field verification_data
|
|
437
437
|
attr_reader :verification_data
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
5
|
module Issuing
|
|
6
|
-
# You can [create physical or virtual cards](https://stripe.com/
|
|
6
|
+
# You can [create physical or virtual cards](https://docs.stripe.com/issuing) that are issued to cardholders.
|
|
7
7
|
class Card < APIResource
|
|
8
8
|
extend Stripe::APIOperations::Create
|
|
9
9
|
extend Stripe::APIOperations::List
|
|
@@ -41,7 +41,7 @@ module Stripe
|
|
|
41
41
|
attr_reader :line2
|
|
42
42
|
# ZIP or postal code.
|
|
43
43
|
attr_reader :postal_code
|
|
44
|
-
# State, county, province, or region.
|
|
44
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
45
45
|
attr_reader :state
|
|
46
46
|
|
|
47
47
|
def self.inner_class_types
|
|
@@ -65,7 +65,7 @@ module Stripe
|
|
|
65
65
|
attr_reader :line2
|
|
66
66
|
# ZIP or postal code.
|
|
67
67
|
attr_reader :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_reader :state
|
|
70
70
|
|
|
71
71
|
def self.inner_class_types
|
|
@@ -146,9 +146,9 @@ module Stripe
|
|
|
146
146
|
|
|
147
147
|
class SpendingControls < ::Stripe::StripeObject
|
|
148
148
|
class SpendingLimit < ::Stripe::StripeObject
|
|
149
|
-
# Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/
|
|
149
|
+
# Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
150
150
|
attr_reader :amount
|
|
151
|
-
# Array of strings containing [categories](https://stripe.com/
|
|
151
|
+
# Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
|
|
152
152
|
attr_reader :categories
|
|
153
153
|
# Interval (or event) to which the amount applies.
|
|
154
154
|
attr_reader :interval
|
|
@@ -161,11 +161,11 @@ module Stripe
|
|
|
161
161
|
@field_remappings = {}
|
|
162
162
|
end
|
|
163
163
|
end
|
|
164
|
-
# Array of strings containing [categories](https://stripe.com/
|
|
164
|
+
# Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
|
|
165
165
|
attr_reader :allowed_categories
|
|
166
166
|
# Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
|
|
167
167
|
attr_reader :allowed_merchant_countries
|
|
168
|
-
# Array of strings containing [categories](https://stripe.com/
|
|
168
|
+
# Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
|
|
169
169
|
attr_reader :blocked_categories
|
|
170
170
|
# Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
|
|
171
171
|
attr_reader :blocked_merchant_countries
|
|
@@ -189,6 +189,8 @@ module Stripe
|
|
|
189
189
|
attr_reader :eligible
|
|
190
190
|
# Reason the card is ineligible for Apple Pay
|
|
191
191
|
attr_reader :ineligible_reason
|
|
192
|
+
# Unique identifier for the card in Apple Pay
|
|
193
|
+
attr_reader :primary_account_identifier
|
|
192
194
|
|
|
193
195
|
def self.inner_class_types
|
|
194
196
|
@inner_class_types = {}
|
|
@@ -204,6 +206,8 @@ module Stripe
|
|
|
204
206
|
attr_reader :eligible
|
|
205
207
|
# Reason the card is ineligible for Google Pay
|
|
206
208
|
attr_reader :ineligible_reason
|
|
209
|
+
# Unique identifier for the card in Google Pay
|
|
210
|
+
attr_reader :primary_account_identifier
|
|
207
211
|
|
|
208
212
|
def self.inner_class_types
|
|
209
213
|
@inner_class_types = {}
|
|
@@ -232,15 +236,15 @@ module Stripe
|
|
|
232
236
|
attr_reader :brand
|
|
233
237
|
# The reason why the card was canceled.
|
|
234
238
|
attr_reader :cancellation_reason
|
|
235
|
-
# An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/
|
|
239
|
+
# An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://docs.stripe.com/issuing) cards.
|
|
236
240
|
#
|
|
237
|
-
# Related guide: [How to create a cardholder](https://stripe.com/
|
|
241
|
+
# Related guide: [How to create a cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder)
|
|
238
242
|
attr_reader :cardholder
|
|
239
243
|
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
240
244
|
attr_reader :created
|
|
241
245
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK.
|
|
242
246
|
attr_reader :currency
|
|
243
|
-
# The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/
|
|
247
|
+
# The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint.
|
|
244
248
|
attr_reader :cvc
|
|
245
249
|
# The expiration month of the card.
|
|
246
250
|
attr_reader :exp_month
|
|
@@ -256,9 +260,9 @@ module Stripe
|
|
|
256
260
|
attr_reader :latest_fraud_warning
|
|
257
261
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
258
262
|
attr_reader :livemode
|
|
259
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
263
|
+
# 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.
|
|
260
264
|
attr_reader :metadata
|
|
261
|
-
# The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/
|
|
265
|
+
# The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint.
|
|
262
266
|
attr_reader :number
|
|
263
267
|
# String representing the object's type. Objects of the same type share the same value.
|
|
264
268
|
attr_reader :object
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
5
|
module Issuing
|
|
6
|
-
# An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/
|
|
6
|
+
# An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://docs.stripe.com/issuing) cards.
|
|
7
7
|
#
|
|
8
|
-
# Related guide: [How to create a cardholder](https://stripe.com/
|
|
8
|
+
# Related guide: [How to create a cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder)
|
|
9
9
|
class Cardholder < APIResource
|
|
10
10
|
extend Stripe::APIOperations::Create
|
|
11
11
|
extend Stripe::APIOperations::List
|
|
@@ -28,7 +28,7 @@ module Stripe
|
|
|
28
28
|
attr_reader :line2
|
|
29
29
|
# ZIP or postal code.
|
|
30
30
|
attr_reader :postal_code
|
|
31
|
-
# State, county, province, or region.
|
|
31
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
32
32
|
attr_reader :state
|
|
33
33
|
|
|
34
34
|
def self.inner_class_types
|
|
@@ -113,9 +113,9 @@ module Stripe
|
|
|
113
113
|
|
|
114
114
|
class Verification < ::Stripe::StripeObject
|
|
115
115
|
class Document < ::Stripe::StripeObject
|
|
116
|
-
# The back of a document returned by a [file upload](https://stripe.com
|
|
116
|
+
# The back of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.
|
|
117
117
|
attr_reader :back
|
|
118
|
-
# The front of a document returned by a [file upload](https://stripe.com
|
|
118
|
+
# The front of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.
|
|
119
119
|
attr_reader :front
|
|
120
120
|
|
|
121
121
|
def self.inner_class_types
|
|
@@ -174,9 +174,9 @@ module Stripe
|
|
|
174
174
|
|
|
175
175
|
class SpendingControls < ::Stripe::StripeObject
|
|
176
176
|
class SpendingLimit < ::Stripe::StripeObject
|
|
177
|
-
# Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/
|
|
177
|
+
# Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
178
178
|
attr_reader :amount
|
|
179
|
-
# Array of strings containing [categories](https://stripe.com/
|
|
179
|
+
# Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.
|
|
180
180
|
attr_reader :categories
|
|
181
181
|
# Interval (or event) to which the amount applies.
|
|
182
182
|
attr_reader :interval
|
|
@@ -189,11 +189,11 @@ module Stripe
|
|
|
189
189
|
@field_remappings = {}
|
|
190
190
|
end
|
|
191
191
|
end
|
|
192
|
-
# Array of strings containing [categories](https://stripe.com/
|
|
192
|
+
# Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
|
|
193
193
|
attr_reader :allowed_categories
|
|
194
194
|
# Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.
|
|
195
195
|
attr_reader :allowed_merchant_countries
|
|
196
|
-
# Array of strings containing [categories](https://stripe.com/
|
|
196
|
+
# Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.
|
|
197
197
|
attr_reader :blocked_categories
|
|
198
198
|
# Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.
|
|
199
199
|
attr_reader :blocked_merchant_countries
|
|
@@ -224,24 +224,24 @@ module Stripe
|
|
|
224
224
|
attr_reader :individual
|
|
225
225
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
226
226
|
attr_reader :livemode
|
|
227
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
227
|
+
# 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.
|
|
228
228
|
attr_reader :metadata
|
|
229
229
|
# The cardholder's name. This will be printed on cards issued to them.
|
|
230
230
|
attr_reader :name
|
|
231
231
|
# String representing the object's type. Objects of the same type share the same value.
|
|
232
232
|
attr_reader :object
|
|
233
|
-
# The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/
|
|
233
|
+
# The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details.
|
|
234
234
|
attr_reader :phone_number
|
|
235
235
|
# The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.
|
|
236
|
-
# This changes the language of the [3D Secure flow](https://stripe.com/
|
|
236
|
+
# This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder.
|
|
237
237
|
attr_reader :preferred_locales
|
|
238
238
|
# Attribute for field requirements
|
|
239
239
|
attr_reader :requirements
|
|
240
|
-
# Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/
|
|
240
|
+
# Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details.
|
|
241
241
|
attr_reader :spending_controls
|
|
242
242
|
# Specifies whether to permit authorizations on this cardholder's cards.
|
|
243
243
|
attr_reader :status
|
|
244
|
-
# One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/
|
|
244
|
+
# One of `individual` or `company`. See [Choose a cardholder type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details.
|
|
245
245
|
attr_reader :type
|
|
246
246
|
|
|
247
247
|
# Creates a new Issuing Cardholder object that can be issued cards.
|
|
@@ -5,7 +5,7 @@ module Stripe
|
|
|
5
5
|
module Issuing
|
|
6
6
|
# Every time an applicant submits an application for a Charge Card product your platform offers, or every time your platform takes a proactive credit decision on an existing account, you must record the decision by creating a new `CreditUnderwritingRecord` object on a connected account.
|
|
7
7
|
#
|
|
8
|
-
# [Follow the guide](https://stripe.com/
|
|
8
|
+
# [Follow the guide](https://docs.stripe.com/issuing/credit/report-credit-decisions-and-manage-aans) to learn about your requirements as a platform.
|
|
9
9
|
class CreditUnderwritingRecord < APIResource
|
|
10
10
|
extend Stripe::APIOperations::List
|
|
11
11
|
|
|
@@ -63,7 +63,7 @@ module Stripe
|
|
|
63
63
|
end
|
|
64
64
|
|
|
65
65
|
class CreditLimitApproved < ::Stripe::StripeObject
|
|
66
|
-
# Credit amount approved. An approved credit limit is required before you can set a amount in the [CreditPolicy API](https://stripe.com/
|
|
66
|
+
# Credit amount approved. An approved credit limit is required before you can set a amount in the [CreditPolicy API](https://docs.stripe.com/api/issuing/credit_policy).
|
|
67
67
|
attr_reader :amount
|
|
68
68
|
# 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).
|
|
69
69
|
attr_reader :currency
|
|
@@ -78,7 +78,7 @@ module Stripe
|
|
|
78
78
|
end
|
|
79
79
|
|
|
80
80
|
class CreditLimitDecreased < ::Stripe::StripeObject
|
|
81
|
-
# Credit amount approved after decrease. An approved credit limit is required before you can set a amount in the [CreditPolicy API](https://stripe.com/
|
|
81
|
+
# Credit amount approved after decrease. An approved credit limit is required before you can set a amount in the [CreditPolicy API](https://docs.stripe.com/api/issuing/credit_policy).
|
|
82
82
|
attr_reader :amount
|
|
83
83
|
# 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).
|
|
84
84
|
attr_reader :currency
|
|
@@ -167,11 +167,11 @@ module Stripe
|
|
|
167
167
|
attr_reader :id
|
|
168
168
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
169
169
|
attr_reader :livemode
|
|
170
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
170
|
+
# 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.
|
|
171
171
|
attr_reader :metadata
|
|
172
172
|
# String representing the object's type. Objects of the same type share the same value.
|
|
173
173
|
attr_reader :object
|
|
174
|
-
# File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/
|
|
174
|
+
# File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://docs.stripe.com/issuing/credit/report-required-regulatory-data-for-credit-decisions).
|
|
175
175
|
attr_reader :regulatory_reporting_file
|
|
176
176
|
# If an exception to the usual underwriting criteria was made for this application, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.
|
|
177
177
|
attr_reader :underwriting_exception
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
5
|
module Issuing
|
|
6
|
-
# As a [card issuer](https://stripe.com/
|
|
6
|
+
# As a [card issuer](https://docs.stripe.com/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.
|
|
7
7
|
#
|
|
8
|
-
# Related guide: [Issuing disputes](https://stripe.com/
|
|
8
|
+
# Related guide: [Issuing disputes](https://docs.stripe.com/issuing/purchases/disputes)
|
|
9
9
|
class Dispute < APIResource
|
|
10
10
|
extend Stripe::APIOperations::Create
|
|
11
11
|
extend Stripe::APIOperations::List
|
|
@@ -222,9 +222,9 @@ module Stripe
|
|
|
222
222
|
end
|
|
223
223
|
|
|
224
224
|
class Treasury < ::Stripe::StripeObject
|
|
225
|
-
# The Treasury [DebitReversal](https://stripe.com/
|
|
225
|
+
# The Treasury [DebitReversal](https://docs.stripe.com/api/treasury/debit_reversals) representing this Issuing dispute
|
|
226
226
|
attr_reader :debit_reversal
|
|
227
|
-
# The Treasury [ReceivedDebit](https://stripe.com/
|
|
227
|
+
# The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) that is being disputed.
|
|
228
228
|
attr_reader :received_debit
|
|
229
229
|
|
|
230
230
|
def self.inner_class_types
|
|
@@ -235,7 +235,7 @@ module Stripe
|
|
|
235
235
|
@field_remappings = {}
|
|
236
236
|
end
|
|
237
237
|
end
|
|
238
|
-
# Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/
|
|
238
|
+
# Disputed amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation).
|
|
239
239
|
attr_reader :amount
|
|
240
240
|
# List of balance transactions associated with the dispute.
|
|
241
241
|
attr_reader :balance_transactions
|
|
@@ -251,7 +251,7 @@ module Stripe
|
|
|
251
251
|
attr_reader :livemode
|
|
252
252
|
# The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values.
|
|
253
253
|
attr_reader :loss_reason
|
|
254
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
254
|
+
# 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.
|
|
255
255
|
attr_reader :metadata
|
|
256
256
|
# String representing the object's type. Objects of the same type share the same value.
|
|
257
257
|
attr_reader :object
|
|
@@ -259,7 +259,7 @@ module Stripe
|
|
|
259
259
|
attr_reader :status
|
|
260
260
|
# The transaction being disputed.
|
|
261
261
|
attr_reader :transaction
|
|
262
|
-
# [Treasury](https://stripe.com/
|
|
262
|
+
# [Treasury](https://docs.stripe.com/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
|
|
263
263
|
attr_reader :treasury
|
|
264
264
|
|
|
265
265
|
# Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements.
|
|
@@ -14,7 +14,7 @@ module Stripe
|
|
|
14
14
|
|
|
15
15
|
# Debited amount. This is equal to the disputed amount and is given in the card’s currency and in the smallest currency unit.
|
|
16
16
|
attr_reader :amount
|
|
17
|
-
# ID of the [balance transaction](https://stripe.com/
|
|
17
|
+
# ID of the [balance transaction](https://docs.stripe.com/api/balance_transactions) associated with this debit.
|
|
18
18
|
attr_reader :balance_transaction
|
|
19
19
|
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
20
20
|
attr_reader :created
|
|
@@ -74,7 +74,7 @@ module Stripe
|
|
|
74
74
|
attr_reader :livemode
|
|
75
75
|
# A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
|
|
76
76
|
attr_reader :lookup_key
|
|
77
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
77
|
+
# 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.
|
|
78
78
|
attr_reader :metadata
|
|
79
79
|
# Friendly display name.
|
|
80
80
|
attr_reader :name
|
|
@@ -20,7 +20,7 @@ module Stripe
|
|
|
20
20
|
attr_reader :id
|
|
21
21
|
# Whether or not this is the "default" issuing program new cards are created on. Only one active `is_default` program at the same time.
|
|
22
22
|
attr_reader :is_default
|
|
23
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
23
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
24
24
|
attr_reader :metadata
|
|
25
25
|
# String representing the object's type. Objects of the same type share the same value.
|
|
26
26
|
attr_reader :object
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
5
|
module Issuing
|
|
6
|
-
# When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/
|
|
6
|
+
# When a non-stripe BIN is used, any use of an [issued card](https://docs.stripe.com/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.
|
|
7
7
|
class Settlement < APIResource
|
|
8
8
|
OBJECT_NAME = "issuing.settlement"
|
|
9
9
|
def self.object_name
|
|
@@ -24,7 +24,7 @@ module Stripe
|
|
|
24
24
|
attr_reader :interchange_fees_amount
|
|
25
25
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
26
26
|
attr_reader :livemode
|
|
27
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
27
|
+
# 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.
|
|
28
28
|
attr_reader :metadata
|
|
29
29
|
# The total net amount required to settle with the network.
|
|
30
30
|
attr_reader :net_total_amount
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
5
|
module Issuing
|
|
6
|
-
# An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/
|
|
6
|
+
# An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://docs.stripe.com/issuing), you can [view and manage these tokens](https://docs.stripe.com/issuing/controls/token-management) through Stripe.
|
|
7
7
|
class Token < APIResource
|
|
8
8
|
extend Stripe::APIOperations::List
|
|
9
9
|
include Stripe::APIOperations::Save
|
|
@@ -3,11 +3,11 @@
|
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
5
|
module Issuing
|
|
6
|
-
# Any use of an [issued card](https://stripe.com/
|
|
6
|
+
# Any use of an [issued card](https://docs.stripe.com/issuing) that results in funds entering or leaving
|
|
7
7
|
# your Stripe account, such as a completed purchase or refund, is represented by an Issuing
|
|
8
8
|
# `Transaction` object.
|
|
9
9
|
#
|
|
10
|
-
# Related guide: [Issued card transactions](https://stripe.com/
|
|
10
|
+
# Related guide: [Issued card transactions](https://docs.stripe.com/issuing/purchases/transactions)
|
|
11
11
|
class Transaction < APIResource
|
|
12
12
|
extend Stripe::APIOperations::List
|
|
13
13
|
include Stripe::APIOperations::Save
|
|
@@ -33,7 +33,7 @@ module Stripe
|
|
|
33
33
|
end
|
|
34
34
|
|
|
35
35
|
class MerchantData < ::Stripe::StripeObject
|
|
36
|
-
# A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/
|
|
36
|
+
# A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values.
|
|
37
37
|
attr_reader :category
|
|
38
38
|
# The merchant category code for the seller’s business
|
|
39
39
|
attr_reader :category_code
|
|
@@ -308,9 +308,9 @@ module Stripe
|
|
|
308
308
|
end
|
|
309
309
|
|
|
310
310
|
class Treasury < ::Stripe::StripeObject
|
|
311
|
-
# The Treasury [ReceivedCredit](https://stripe.com/
|
|
311
|
+
# The Treasury [ReceivedCredit](https://docs.stripe.com/api/treasury/received_credits) representing this Issuing transaction if it is a refund
|
|
312
312
|
attr_reader :received_credit
|
|
313
|
-
# The Treasury [ReceivedDebit](https://stripe.com/
|
|
313
|
+
# The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) representing this Issuing transaction if it is a capture
|
|
314
314
|
attr_reader :received_debit
|
|
315
315
|
|
|
316
316
|
def self.inner_class_types
|
|
@@ -321,13 +321,13 @@ module Stripe
|
|
|
321
321
|
@field_remappings = {}
|
|
322
322
|
end
|
|
323
323
|
end
|
|
324
|
-
# The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/
|
|
324
|
+
# The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
325
325
|
attr_reader :amount
|
|
326
|
-
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/
|
|
326
|
+
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
327
327
|
attr_reader :amount_details
|
|
328
328
|
# The `Authorization` object that led to this transaction.
|
|
329
329
|
attr_reader :authorization
|
|
330
|
-
# ID of the [balance transaction](https://stripe.com/
|
|
330
|
+
# ID of the [balance transaction](https://docs.stripe.com/api/balance_transactions) associated with this transaction.
|
|
331
331
|
attr_reader :balance_transaction
|
|
332
332
|
# The card used to make this transaction.
|
|
333
333
|
attr_reader :card
|
|
@@ -343,13 +343,13 @@ module Stripe
|
|
|
343
343
|
attr_reader :id
|
|
344
344
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
345
345
|
attr_reader :livemode
|
|
346
|
-
# The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/
|
|
346
|
+
# The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency.
|
|
347
347
|
attr_reader :merchant_amount
|
|
348
348
|
# The currency with which the merchant is taking payment.
|
|
349
349
|
attr_reader :merchant_currency
|
|
350
350
|
# Attribute for field merchant_data
|
|
351
351
|
attr_reader :merchant_data
|
|
352
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
352
|
+
# 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.
|
|
353
353
|
attr_reader :metadata
|
|
354
354
|
# Details about the transaction, such as processing dates, set by the card network.
|
|
355
355
|
attr_reader :network_data
|
|
@@ -357,11 +357,11 @@ module Stripe
|
|
|
357
357
|
attr_reader :object
|
|
358
358
|
# Additional purchase information that is optionally provided by the merchant.
|
|
359
359
|
attr_reader :purchase_details
|
|
360
|
-
# The ID of the [settlement](https://stripe.com/
|
|
360
|
+
# The ID of the [settlement](https://docs.stripe.com/api/issuing/settlements) to which this transaction belongs.
|
|
361
361
|
attr_reader :settlement
|
|
362
|
-
# [Token](https://stripe.com/
|
|
362
|
+
# [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.
|
|
363
363
|
attr_reader :token
|
|
364
|
-
# [Treasury](https://stripe.com/
|
|
364
|
+
# [Treasury](https://docs.stripe.com/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
|
|
365
365
|
attr_reader :treasury
|
|
366
366
|
# The nature of the transaction.
|
|
367
367
|
attr_reader :type
|
|
@@ -29,10 +29,10 @@ module Stripe
|
|
|
29
29
|
class Discount < ::Stripe::StripeObject
|
|
30
30
|
# The amount discounted.
|
|
31
31
|
attr_reader :amount
|
|
32
|
-
# A discount represents the actual application of a [coupon](https://stripe.com
|
|
32
|
+
# A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
|
|
33
33
|
# It contains information about when the discount began, when it will end, and what it is applied to.
|
|
34
34
|
#
|
|
35
|
-
# Related guide: [Applying discounts to subscriptions](https://stripe.com/
|
|
35
|
+
# Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
|
|
36
36
|
attr_reader :discount
|
|
37
37
|
|
|
38
38
|
def self.inner_class_types
|
|
@@ -116,7 +116,7 @@ module Stripe
|
|
|
116
116
|
attr_reader :display
|
|
117
117
|
# Unique identifier for the object.
|
|
118
118
|
attr_reader :id
|
|
119
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
119
|
+
# 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.
|
|
120
120
|
attr_reader :metadata
|
|
121
121
|
# String representing the object's type. Objects of the same type share the same value.
|
|
122
122
|
attr_reader :object
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
5
|
# Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard.
|
|
6
|
-
# A Login Link differs from an [Account Link](https://stripe.com/
|
|
6
|
+
# A Login Link differs from an [Account Link](https://docs.stripe.com/api/account_links) in that it takes the user directly to their [Express dashboard for the specified account](https://docs.stripe.com/connect/integrate-express-dashboard#create-login-link)
|
|
7
7
|
class LoginLink < APIResource
|
|
8
8
|
OBJECT_NAME = "login_link"
|
|
9
9
|
def self.object_name
|
|
@@ -22,7 +22,7 @@ module Stripe
|
|
|
22
22
|
attr_reader :id
|
|
23
23
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
24
24
|
attr_reader :livemode
|
|
25
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
25
|
+
# 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.
|
|
26
26
|
attr_reader :metadata
|
|
27
27
|
# Name of the margin that's displayed on, for example, invoices.
|
|
28
28
|
attr_reader :name
|