stripe 18.1.0.pre.beta.1 → 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 +360 -0
- data/lib/stripe/events/v2_billing_cadence_billed_event.rb +61 -0
- data/lib/stripe/events/v2_billing_cadence_canceled_event.rb +44 -0
- data/lib/stripe/events/v2_billing_cadence_created_event.rb +61 -0
- data/lib/stripe/events/v2_billing_license_fee_created_event.rb +44 -0
- data/lib/stripe/events/v2_billing_license_fee_updated_event.rb +44 -0
- data/lib/stripe/events/v2_billing_license_fee_version_created_event.rb +61 -0
- data/lib/stripe/events/v2_billing_licensed_item_created_event.rb +44 -0
- data/lib/stripe/events/v2_billing_licensed_item_updated_event.rb +44 -0
- data/lib/stripe/events/v2_billing_metered_item_created_event.rb +44 -0
- data/lib/stripe/events/v2_billing_metered_item_updated_event.rb +44 -0
- data/lib/stripe/events/v2_billing_pricing_plan_component_created_event.rb +61 -0
- data/lib/stripe/events/v2_billing_pricing_plan_component_updated_event.rb +61 -0
- data/lib/stripe/events/v2_billing_pricing_plan_created_event.rb +44 -0
- data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_awaiting_customer_action_event.rb +44 -0
- data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_current_event.rb +44 -0
- data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_past_due_event.rb +44 -0
- data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_paused_event.rb +44 -0
- data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_unpaid_event.rb +44 -0
- data/lib/stripe/events/v2_billing_pricing_plan_subscription_servicing_activated_event.rb +44 -0
- data/lib/stripe/events/v2_billing_pricing_plan_subscription_servicing_canceled_event.rb +44 -0
- data/lib/stripe/events/v2_billing_pricing_plan_subscription_servicing_paused_event.rb +44 -0
- data/lib/stripe/events/v2_billing_pricing_plan_updated_event.rb +44 -0
- data/lib/stripe/events/v2_billing_pricing_plan_version_created_event.rb +61 -0
- data/lib/stripe/events/v2_billing_rate_card_created_event.rb +61 -0
- data/lib/stripe/events/v2_billing_rate_card_rate_created_event.rb +67 -0
- data/lib/stripe/events/v2_billing_rate_card_subscription_activated_event.rb +44 -0
- data/lib/stripe/events/v2_billing_rate_card_subscription_canceled_event.rb +44 -0
- data/lib/stripe/events/v2_billing_rate_card_subscription_collection_awaiting_customer_action_event.rb +44 -0
- data/lib/stripe/events/v2_billing_rate_card_subscription_collection_current_event.rb +44 -0
- data/lib/stripe/events/v2_billing_rate_card_subscription_collection_past_due_event.rb +44 -0
- data/lib/stripe/events/v2_billing_rate_card_subscription_collection_paused_event.rb +44 -0
- data/lib/stripe/events/v2_billing_rate_card_subscription_collection_unpaid_event.rb +44 -0
- data/lib/stripe/events/v2_billing_rate_card_subscription_servicing_activated_event.rb +44 -0
- data/lib/stripe/events/v2_billing_rate_card_subscription_servicing_canceled_event.rb +44 -0
- data/lib/stripe/events/v2_billing_rate_card_subscription_servicing_paused_event.rb +44 -0
- data/lib/stripe/events/v2_billing_rate_card_updated_event.rb +44 -0
- data/lib/stripe/events/v2_billing_rate_card_version_created_event.rb +61 -0
- data/lib/stripe/events/v2_core_account_including_configuration_card_creator_capability_status_updated_event.rb +63 -0
- data/lib/stripe/events/v2_core_account_including_configuration_card_creator_updated_event.rb +44 -0
- data/lib/stripe/events/v2_core_claimable_sandbox_claimed_event.rb +44 -0
- data/lib/stripe/events/v2_core_claimable_sandbox_created_event.rb +44 -0
- data/lib/stripe/events/v2_core_claimable_sandbox_expired_event.rb +44 -0
- data/lib/stripe/events/v2_core_claimable_sandbox_expiring_event.rb +44 -0
- data/lib/stripe/events/v2_core_claimable_sandbox_sandbox_details_owner_account_updated_event.rb +44 -0
- data/lib/stripe/events/v2_core_health_api_error_firing_event.rb +86 -0
- data/lib/stripe/events/v2_core_health_api_error_resolved_event.rb +86 -0
- data/lib/stripe/events/v2_core_health_api_latency_firing_event.rb +84 -0
- data/lib/stripe/events/v2_core_health_api_latency_resolved_event.rb +84 -0
- data/lib/stripe/events/v2_core_health_authorization_rate_drop_firing_event.rb +80 -0
- data/lib/stripe/events/v2_core_health_authorization_rate_drop_resolved_event.rb +80 -0
- data/lib/stripe/events/v2_core_health_fraud_rate_increased_event.rb +78 -0
- data/lib/stripe/events/v2_core_health_issuing_authorization_request_errors_firing_event.rb +91 -0
- data/lib/stripe/events/v2_core_health_issuing_authorization_request_errors_resolved_event.rb +93 -0
- data/lib/stripe/events/v2_core_health_issuing_authorization_request_timeout_firing_event.rb +93 -0
- data/lib/stripe/events/v2_core_health_issuing_authorization_request_timeout_resolved_event.rb +93 -0
- data/lib/stripe/events/v2_core_health_payment_method_error_firing_event.rb +82 -0
- data/lib/stripe/events/v2_core_health_payment_method_error_resolved_event.rb +82 -0
- 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_core_health_traffic_volume_drop_firing_event.rb +62 -0
- data/lib/stripe/events/v2_core_health_traffic_volume_drop_resolved_event.rb +62 -0
- data/lib/stripe/events/v2_core_health_webhook_latency_firing_event.rb +58 -0
- data/lib/stripe/events/v2_core_health_webhook_latency_resolved_event.rb +58 -0
- data/lib/stripe/events/v2_iam_api_key_created_event.rb +20 -0
- data/lib/stripe/events/v2_iam_api_key_default_secret_revealed_event.rb +20 -0
- data/lib/stripe/events/v2_iam_api_key_expired_event.rb +20 -0
- data/lib/stripe/events/v2_iam_api_key_permissions_updated_event.rb +20 -0
- data/lib/stripe/events/v2_iam_api_key_rotated_event.rb +38 -0
- data/lib/stripe/events/v2_iam_api_key_updated_event.rb +20 -0
- data/lib/stripe/events/v2_money_management_payout_method_created_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_recipient_verification_created_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_recipient_verification_updated_event.rb +44 -0
- data/lib/stripe/events/v2_payments_off_session_payment_attempt_failed_event.rb +44 -0
- data/lib/stripe/events/v2_payments_off_session_payment_attempt_started_event.rb +46 -0
- data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +46 -0
- data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +48 -0
- data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +44 -0
- data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +44 -0
- data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +44 -0
- data/lib/stripe/events/v2_payments_off_session_payment_requires_capture_event.rb +44 -0
- data/lib/stripe/events/v2_payments_off_session_payment_succeeded_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/events/v2_reporting_report_run_created_event.rb +44 -0
- data/lib/stripe/events/v2_reporting_report_run_failed_event.rb +44 -0
- data/lib/stripe/events/v2_reporting_report_run_succeeded_event.rb +44 -0
- data/lib/stripe/events/v2_reporting_report_run_updated_event.rb +44 -0
- data/lib/stripe/object_types.rb +40 -0
- data/lib/stripe/params/account_create_params.rb +82 -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 +42 -10
- data/lib/stripe/params/account_person_update_params.rb +42 -10
- data/lib/stripe/params/account_session_create_params.rb +17 -0
- data/lib/stripe/params/account_update_params.rb +81 -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 +66 -0
- data/lib/stripe/params/billing/alert_create_params.rb +121 -1
- data/lib/stripe/params/billing/alert_list_params.rb +4 -0
- data/lib/stripe/params/billing/analytics/meter_usage_retrieve_params.rb +5 -1
- data/lib/stripe/params/billing/credit_balance_summary_retrieve_params.rb +15 -3
- data/lib/stripe/params/billing/credit_balance_transaction_list_params.rb +2 -2
- data/lib/stripe/params/billing/credit_grant_create_params.rb +31 -4
- data/lib/stripe/params/billing/credit_grant_list_params.rb +1 -1
- data/lib/stripe/params/billing/meter_create_params.rb +4 -0
- data/lib/stripe/params/billing/meter_event_create_params.rb +1 -1
- data/lib/stripe/params/billing/meter_event_summary_list_params.rb +8 -0
- 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/capital/financing_offer_create_params.rb +37 -0
- data/lib/stripe/params/capital/financing_offer_refill_params.rb +37 -0
- 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 +133 -42
- 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 +138 -0
- data/lib/stripe/params/delegated_checkout/requested_session_create_params.rb +205 -0
- data/lib/stripe/params/delegated_checkout/requested_session_expire_params.rb +15 -0
- data/lib/stripe/params/delegated_checkout/requested_session_retrieve_params.rb +15 -0
- data/lib/stripe/params/delegated_checkout/requested_session_update_params.rb +209 -0
- 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/blocklist_entry_create_params.rb +29 -0
- data/lib/stripe/params/identity/blocklist_entry_disable_params.rb +15 -0
- data/lib/stripe/params/identity/blocklist_entry_list_params.rb +62 -0
- data/lib/stripe/params/identity/blocklist_entry_retrieve_params.rb +15 -0
- data/lib/stripe/params/identity/verification_report_list_params.rb +4 -0
- 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 +158 -39
- 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 +6 -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_create_params.rb +21 -0
- data/lib/stripe/params/issuing/program_list_params.rb +24 -0
- data/lib/stripe/params/issuing/program_retrieve_params.rb +15 -0
- data/lib/stripe/params/issuing/program_update_params.rb +21 -0
- 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 +77 -39
- data/lib/stripe/params/payment_intent_create_params.rb +105 -54
- 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 +74 -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_check_balance_params.rb +13 -0
- 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_catalog/trial_offer_create_params.rb +60 -0
- 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 +231 -11
- data/lib/stripe/params/quote_list_params.rb +2 -2
- data/lib/stripe/params/quote_update_params.rb +231 -11
- data/lib/stripe/params/radar/account_evaluation_create_params.rb +81 -0
- data/lib/stripe/params/radar/account_evaluation_retrieve_params.rb +15 -0
- data/lib/stripe/params/radar/account_evaluation_update_params.rb +18 -0
- 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 +35 -6
- data/lib/stripe/params/setup_intent_create_params.rb +41 -12
- data/lib/stripe/params/setup_intent_update_params.rb +38 -9
- 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 +62 -22
- data/lib/stripe/params/subscription_item_create_params.rb +26 -10
- data/lib/stripe/params/subscription_item_delete_params.rb +2 -2
- data/lib/stripe/params/subscription_item_update_params.rb +26 -10
- 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 +42 -3
- data/lib/stripe/params/subscription_schedule_create_params.rb +85 -17
- data/lib/stripe/params/subscription_schedule_update_params.rb +85 -17
- data/lib/stripe/params/subscription_search_params.rb +1 -1
- data/lib/stripe/params/subscription_update_params.rb +60 -20
- 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/capital/financing_offer_create_params.rb +39 -0
- data/lib/stripe/params/test_helpers/capital/financing_offer_refill_params.rb +39 -0
- 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 +86 -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 +7 -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/cadence_cancel_params.rb +8 -1
- data/lib/stripe/params/v2/billing/cadence_create_params.rb +4 -0
- data/lib/stripe/params/v2/billing/cadence_update_params.rb +4 -1
- data/lib/stripe/params/v2/billing/custom_pricing_unit_create_params.rb +26 -0
- data/lib/stripe/params/v2/billing/custom_pricing_unit_list_params.rb +24 -0
- data/lib/stripe/params/v2/billing/custom_pricing_unit_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/custom_pricing_unit_update_params.rb +26 -0
- data/lib/stripe/params/v2/billing/intent_cancel_params.rb +10 -0
- data/lib/stripe/params/v2/billing/intent_commit_params.rb +17 -0
- data/lib/stripe/params/v2/billing/intent_create_params.rb +425 -0
- data/lib/stripe/params/v2/billing/intent_list_params.rb +17 -0
- data/lib/stripe/params/v2/billing/intent_release_reservation_params.rb +10 -0
- data/lib/stripe/params/v2/billing/intent_reserve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/intent_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/intents/action_list_params.rb +19 -0
- data/lib/stripe/params/v2/billing/intents/action_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/billing/license_fee_create_params.rb +103 -0
- data/lib/stripe/params/v2/billing/license_fee_list_params.rb +24 -0
- data/lib/stripe/params/v2/billing/license_fee_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/license_fee_subscription_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/license_fee_update_params.rb +84 -0
- data/lib/stripe/params/v2/billing/license_fees/version_list_params.rb +19 -0
- data/lib/stripe/params/v2/billing/license_fees/version_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/billing/licensed_item_create_params.rb +48 -0
- data/lib/stripe/params/v2/billing/licensed_item_list_params.rb +21 -0
- data/lib/stripe/params/v2/billing/licensed_item_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/licensed_item_update_params.rb +48 -0
- data/lib/stripe/params/v2/billing/metered_item_create_params.rb +73 -0
- data/lib/stripe/params/v2/billing/metered_item_list_params.rb +21 -0
- data/lib/stripe/params/v2/billing/metered_item_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/metered_item_update_params.rb +50 -0
- data/lib/stripe/params/v2/billing/pricing_plan_create_params.rb +39 -0
- data/lib/stripe/params/v2/billing/pricing_plan_list_params.rb +24 -0
- data/lib/stripe/params/v2/billing/pricing_plan_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/pricing_plan_subscription_list_params.rb +50 -0
- data/lib/stripe/params/v2/billing/pricing_plan_subscription_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/pricing_plan_subscription_update_params.rb +20 -0
- data/lib/stripe/params/v2/billing/pricing_plan_subscriptions/component_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/billing/pricing_plan_update_params.rb +39 -0
- data/lib/stripe/params/v2/billing/pricing_plans/component_create_params.rb +73 -0
- data/lib/stripe/params/v2/billing/pricing_plans/component_delete_params.rb +12 -0
- data/lib/stripe/params/v2/billing/pricing_plans/component_list_params.rb +27 -0
- data/lib/stripe/params/v2/billing/pricing_plans/component_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/billing/pricing_plans/component_update_params.rb +22 -0
- data/lib/stripe/params/v2/billing/pricing_plans/version_list_params.rb +19 -0
- data/lib/stripe/params/v2/billing/pricing_plans/version_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/billing/rate_card_create_params.rb +49 -0
- data/lib/stripe/params/v2/billing/rate_card_list_params.rb +24 -0
- data/lib/stripe/params/v2/billing/rate_card_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/rate_card_subscription_cancel_params.rb +10 -0
- data/lib/stripe/params/v2/billing/rate_card_subscription_create_params.rb +26 -0
- data/lib/stripe/params/v2/billing/rate_card_subscription_list_params.rb +51 -0
- data/lib/stripe/params/v2/billing/rate_card_subscription_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/rate_card_subscription_update_params.rb +17 -0
- data/lib/stripe/params/v2/billing/rate_card_update_params.rb +38 -0
- data/lib/stripe/params/v2/billing/rate_cards/rate_create_params.rb +91 -0
- data/lib/stripe/params/v2/billing/rate_cards/rate_delete_params.rb +12 -0
- data/lib/stripe/params/v2/billing/rate_cards/rate_list_params.rb +25 -0
- data/lib/stripe/params/v2/billing/rate_cards/rate_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/billing/rate_cards/version_list_params.rb +19 -0
- data/lib/stripe/params/v2/billing/rate_cards/version_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/billing/service_action_create_params.rb +278 -0
- data/lib/stripe/params/v2/billing/service_action_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/service_action_update_params.rb +40 -0
- data/lib/stripe/params/v2/core/account_create_params.rb +758 -29
- data/lib/stripe/params/v2/core/account_link_create_params.rb +5 -5
- data/lib/stripe/params/v2/core/account_token_create_params.rb +267 -9
- data/lib/stripe/params/v2/core/account_update_params.rb +750 -35
- 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 +36 -0
- data/lib/stripe/params/v2/core/claimable_sandbox_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/core/event_list_params.rb +4 -1
- data/lib/stripe/params/v2/core/event_retrieve_params.rb +8 -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/currency_conversion_create_params.rb +68 -0
- data/lib/stripe/params/v2/money_management/currency_conversion_list_params.rb +20 -0
- data/lib/stripe/params/v2/money_management/currency_conversion_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/financial_account_list_params.rb +4 -1
- data/lib/stripe/params/v2/money_management/financial_address_create_params.rb +12 -1
- data/lib/stripe/params/v2/money_management/inbound_transfer_create_params.rb +12 -0
- data/lib/stripe/params/v2/money_management/outbound_payment_create_params.rb +20 -1
- data/lib/stripe/params/v2/money_management/outbound_payment_quote_create_params.rb +16 -1
- data/lib/stripe/params/v2/money_management/outbound_setup_intent_create_params.rb +19 -1
- data/lib/stripe/params/v2/money_management/outbound_transfer_create_params.rb +16 -0
- data/lib/stripe/params/v2/money_management/recipient_verification_acknowledge_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/recipient_verification_create_params.rb +20 -0
- data/lib/stripe/params/v2/money_management/recipient_verification_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/payments/off_session_payment_cancel_params.rb +10 -0
- data/lib/stripe/params/v2/payments/off_session_payment_capture_params.rb +57 -0
- data/lib/stripe/params/v2/payments/off_session_payment_create_params.rb +161 -0
- data/lib/stripe/params/v2/payments/off_session_payment_list_params.rb +17 -0
- data/lib/stripe/params/v2/payments/off_session_payment_retrieve_params.rb +10 -0
- 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/reporting/report_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/reporting/report_run_create_params.rb +33 -0
- data/lib/stripe/params/v2/reporting/report_run_retrieve_params.rb +10 -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/v2/test_helpers/financial_address_credit_params.rb +11 -0
- data/lib/stripe/params/v2/test_helpers/money_management_recipient_verifications_params.rb +24 -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 +125 -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 +29 -2
- data/lib/stripe/resources/application_fee.rb +2 -0
- 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 +85 -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 +139 -0
- data/lib/stripe/resources/bank_account.rb +10 -10
- data/lib/stripe/resources/billing/alert.rb +106 -2
- data/lib/stripe/resources/billing/alert_triggered.rb +6 -0
- data/lib/stripe/resources/billing/analytics/meter_usage_row.rb +2 -0
- data/lib/stripe/resources/billing/credit_balance_summary.rb +84 -2
- data/lib/stripe/resources/billing/credit_balance_transaction.rb +84 -2
- data/lib/stripe/resources/billing/credit_grant.rb +60 -4
- data/lib/stripe/resources/billing/meter.rb +2 -0
- data/lib/stripe/resources/billing/meter_event.rb +1 -1
- data/lib/stripe/resources/billing/meter_event_summary.rb +2 -0
- 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 +43 -2
- data/lib/stripe/resources/capital/financing_summary.rb +7 -4
- data/lib/stripe/resources/card.rb +20 -3
- data/lib/stripe/resources/cash_balance.rb +2 -2
- data/lib/stripe/resources/charge.rb +65 -35
- data/lib/stripe/resources/checkout/session.rb +111 -19
- data/lib/stripe/resources/climate/order.rb +1 -1
- data/lib/stripe/resources/confirmation_token.rb +29 -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 +479 -0
- data/lib/stripe/resources/discount.rb +5 -3
- 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 +116 -0
- data/lib/stripe/resources/identity/verification_report.rb +13 -9
- data/lib/stripe/resources/identity/verification_session.rb +11 -11
- data/lib/stripe/resources/invoice.rb +79 -31
- data/lib/stripe/resources/invoice_item.rb +112 -8
- data/lib/stripe/resources/invoice_line_item.rb +111 -5
- 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 +69 -0
- 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 +161 -58
- 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 +51 -13
- data/lib/stripe/resources/payment_method_balance.rb +68 -0
- 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 +59 -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/product_catalog/trial_offer.rb +101 -0
- data/lib/stripe/resources/promotion_code.rb +4 -4
- data/lib/stripe/resources/quote.rb +253 -16
- data/lib/stripe/resources/quote_line.rb +9 -3
- data/lib/stripe/resources/quote_preview_invoice.rb +77 -29
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +102 -8
- data/lib/stripe/resources/radar/account_evaluation.rb +116 -0
- 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 +59 -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 +66 -15
- data/lib/stripe/resources/subscription_item.rb +31 -8
- data/lib/stripe/resources/subscription_schedule.rb +103 -9
- 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 +9 -5
- data/lib/stripe/resources/transit_balance.rb +45 -0
- 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/cadence.rb +46 -0
- data/lib/stripe/resources/v2/billing/custom_pricing_unit.rb +43 -0
- data/lib/stripe/resources/v2/billing/intent.rb +86 -0
- data/lib/stripe/resources/v2/billing/intent_action.rb +483 -0
- data/lib/stripe/resources/v2/billing/license_fee.rb +104 -0
- data/lib/stripe/resources/v2/billing/license_fee_subscription.rb +44 -0
- data/lib/stripe/resources/v2/billing/license_fee_version.rb +80 -0
- data/lib/stripe/resources/v2/billing/licensed_item.rb +60 -0
- data/lib/stripe/resources/v2/billing/metered_item.rb +85 -0
- data/lib/stripe/resources/v2/billing/pricing_plan.rb +51 -0
- data/lib/stripe/resources/v2/billing/pricing_plan_component.rb +94 -0
- data/lib/stripe/resources/v2/billing/pricing_plan_subscription.rb +94 -0
- data/lib/stripe/resources/v2/billing/pricing_plan_subscription_components.rb +49 -0
- data/lib/stripe/resources/v2/billing/pricing_plan_version.rb +38 -0
- data/lib/stripe/resources/v2/billing/rate_card.rb +61 -0
- data/lib/stripe/resources/v2/billing/rate_card_rate.rb +110 -0
- data/lib/stripe/resources/v2/billing/rate_card_subscription.rb +94 -0
- data/lib/stripe/resources/v2/billing/rate_card_version.rb +34 -0
- data/lib/stripe/resources/v2/billing/service_action.rb +274 -0
- data/lib/stripe/resources/v2/core/account.rb +1227 -253
- 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/claimable_sandbox.rb +105 -0
- data/lib/stripe/resources/v2/core/event.rb +50 -1
- 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/financial_address_generated_microdeposits.rb +15 -1
- data/lib/stripe/resources/v2/iam/api_key.rb +129 -0
- data/lib/stripe/resources/v2/money_management/adjustment.rb +16 -1
- data/lib/stripe/resources/v2/money_management/currency_conversion.rb +94 -0
- data/lib/stripe/resources/v2/money_management/financial_account.rb +83 -0
- data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +52 -3
- data/lib/stripe/resources/v2/money_management/outbound_payment.rb +50 -2
- data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +63 -3
- data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +48 -2
- data/lib/stripe/resources/v2/money_management/payout_method.rb +49 -1
- data/lib/stripe/resources/v2/money_management/received_credit.rb +52 -0
- data/lib/stripe/resources/v2/money_management/received_debit.rb +73 -1
- data/lib/stripe/resources/v2/money_management/recipient_verification.rb +83 -0
- data/lib/stripe/resources/v2/money_management/transaction.rb +65 -1
- data/lib/stripe/resources/v2/money_management/transaction_entry.rb +49 -1
- data/lib/stripe/resources/v2/payments/off_session_payment.rb +186 -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/reporting/report.rb +116 -0
- data/lib/stripe/resources/v2/reporting/report_run.rb +128 -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 +133 -0
- data/lib/stripe/services/balance_transfer_service.rb +17 -0
- data/lib/stripe/services/capital/financing_summary_service.rb +1 -1
- data/lib/stripe/services/delegated_checkout/requested_session_service.rb +63 -0
- data/lib/stripe/services/delegated_checkout_service.rb +13 -0
- data/lib/stripe/services/identity/blocklist_entry_service.rb +71 -0
- data/lib/stripe/services/identity_service.rb +2 -1
- data/lib/stripe/services/issuing/program_service.rb +52 -0
- data/lib/stripe/services/issuing_service.rb +2 -1
- data/lib/stripe/services/payment_method_service.rb +12 -1
- data/lib/stripe/services/product_catalog/trial_offer_service.rb +19 -0
- data/lib/stripe/services/product_catalog_service.rb +13 -0
- data/lib/stripe/services/radar/account_evaluation_service.rb +41 -0
- data/lib/stripe/services/radar_service.rb +2 -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/capital/financing_offer_service.rb +32 -0
- data/lib/stripe/services/test_helpers/capital_service.rb +15 -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 +3 -1
- data/lib/stripe/services/v1_services.rb +5 -1
- data/lib/stripe/services/v2/billing/custom_pricing_unit_service.rb +54 -0
- data/lib/stripe/services/v2/billing/intent_service.rb +94 -0
- data/lib/stripe/services/v2/billing/intents/action_service.rb +34 -0
- data/lib/stripe/services/v2/billing/license_fee_service.rb +61 -0
- data/lib/stripe/services/v2/billing/license_fee_subscription_service.rb +21 -0
- data/lib/stripe/services/v2/billing/license_fees/version_service.rb +34 -0
- data/lib/stripe/services/v2/billing/licensed_item_service.rb +54 -0
- data/lib/stripe/services/v2/billing/metered_item_service.rb +54 -0
- data/lib/stripe/services/v2/billing/pricing_plan_service.rb +62 -0
- data/lib/stripe/services/v2/billing/pricing_plan_subscription_service.rb +51 -0
- data/lib/stripe/services/v2/billing/pricing_plan_subscriptions/component_service.rb +23 -0
- data/lib/stripe/services/v2/billing/pricing_plans/component_service.rb +67 -0
- data/lib/stripe/services/v2/billing/pricing_plans/version_service.rb +34 -0
- data/lib/stripe/services/v2/billing/rate_card_service.rb +62 -0
- data/lib/stripe/services/v2/billing/rate_card_subscription_service.rb +65 -0
- data/lib/stripe/services/v2/billing/rate_cards/rate_service.rb +57 -0
- data/lib/stripe/services/v2/billing/rate_cards/version_service.rb +34 -0
- data/lib/stripe/services/v2/billing/service_action_service.rb +43 -0
- data/lib/stripe/services/v2/billing_service.rb +14 -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/core/claimable_sandbox_service.rb +35 -0
- data/lib/stripe/services/v2/core_service.rb +2 -1
- 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/currency_conversion_service.rb +45 -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/money_management/recipient_verification_service.rb +43 -0
- data/lib/stripe/services/v2/money_management_service.rb +5 -1
- data/lib/stripe/services/v2/payment_service.rb +17 -0
- data/lib/stripe/services/v2/payments/off_session_payment_service.rb +65 -0
- 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/reporting/report_run_service.rb +38 -0
- data/lib/stripe/services/v2/reporting/report_service.rb +23 -0
- data/lib/stripe/services/v2/reporting_service.rb +16 -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/test_helper_service.rb +2 -1
- data/lib/stripe/services/v2/test_helpers/money_management_service.rb +21 -0
- data/lib/stripe/services/v2_services.rb +5 -1
- data/lib/stripe/services.rb +47 -0
- data/lib/stripe/stripe_object.rb +30 -1
- data/lib/stripe/version.rb +1 -1
- data/rbi/stripe.rbi +24028 -3406
- metadata +307 -2
|
@@ -76,11 +76,11 @@ module Stripe
|
|
|
76
76
|
# just like a `Card` object: once chargeable, they can be charged, or can be
|
|
77
77
|
# attached to customers.
|
|
78
78
|
#
|
|
79
|
-
# Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/
|
|
80
|
-
# We recommend that you adopt the [PaymentMethods API](https://stripe.com/
|
|
79
|
+
# Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources).
|
|
80
|
+
# We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods).
|
|
81
81
|
# This newer API provides access to our latest features and payment method types.
|
|
82
82
|
#
|
|
83
|
-
# Related guides: [Sources API](https://stripe.com/
|
|
83
|
+
# Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers).
|
|
84
84
|
attr_reader :source
|
|
85
85
|
# The status of the mandate notification. Valid statuses are `pending` or `submitted`.
|
|
86
86
|
attr_reader :status
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
module Stripe
|
|
5
5
|
# Subscriptions allow you to charge a customer on a recurring basis.
|
|
6
6
|
#
|
|
7
|
-
# Related guide: [Creating subscriptions](https://stripe.com/
|
|
7
|
+
# Related guide: [Creating subscriptions](https://docs.stripe.com/billing/subscriptions/creating)
|
|
8
8
|
class Subscription < APIResource
|
|
9
9
|
extend Stripe::APIOperations::Create
|
|
10
10
|
extend Stripe::APIOperations::List
|
|
@@ -113,6 +113,23 @@ module Stripe
|
|
|
113
113
|
end
|
|
114
114
|
end
|
|
115
115
|
|
|
116
|
+
class BillFrom < ::Stripe::StripeObject
|
|
117
|
+
# The time the billing schedule applies from.
|
|
118
|
+
attr_reader :computed_timestamp
|
|
119
|
+
# Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
|
|
120
|
+
attr_reader :timestamp
|
|
121
|
+
# Describes how the billing schedule determines the start date. Possible values are `timestamp`.
|
|
122
|
+
attr_reader :type
|
|
123
|
+
|
|
124
|
+
def self.inner_class_types
|
|
125
|
+
@inner_class_types = {}
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
def self.field_remappings
|
|
129
|
+
@field_remappings = {}
|
|
130
|
+
end
|
|
131
|
+
end
|
|
132
|
+
|
|
116
133
|
class BillUntil < ::Stripe::StripeObject
|
|
117
134
|
class Duration < ::Stripe::StripeObject
|
|
118
135
|
# Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
@@ -147,13 +164,15 @@ module Stripe
|
|
|
147
164
|
end
|
|
148
165
|
# Specifies which subscription items the billing schedule applies to.
|
|
149
166
|
attr_reader :applies_to
|
|
167
|
+
# Specifies the start of the billing period.
|
|
168
|
+
attr_reader :bill_from
|
|
150
169
|
# Specifies the end of billing period.
|
|
151
170
|
attr_reader :bill_until
|
|
152
171
|
# Unique identifier for the billing schedule.
|
|
153
172
|
attr_reader :key
|
|
154
173
|
|
|
155
174
|
def self.inner_class_types
|
|
156
|
-
@inner_class_types = { applies_to: AppliesTo, bill_until: BillUntil }
|
|
175
|
+
@inner_class_types = { applies_to: AppliesTo, bill_from: BillFrom, bill_until: BillUntil }
|
|
157
176
|
end
|
|
158
177
|
|
|
159
178
|
def self.field_remappings
|
|
@@ -331,7 +350,7 @@ module Stripe
|
|
|
331
350
|
attr_reader :mandate_options
|
|
332
351
|
# Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
|
|
333
352
|
attr_reader :network
|
|
334
|
-
# 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/
|
|
353
|
+
# 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.
|
|
335
354
|
attr_reader :request_three_d_secure
|
|
336
355
|
|
|
337
356
|
def self.inner_class_types
|
|
@@ -404,6 +423,35 @@ module Stripe
|
|
|
404
423
|
end
|
|
405
424
|
end
|
|
406
425
|
|
|
426
|
+
class Payto < ::Stripe::StripeObject
|
|
427
|
+
class MandateOptions < ::Stripe::StripeObject
|
|
428
|
+
# The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
|
|
429
|
+
attr_reader :amount
|
|
430
|
+
# Only `maximum` is supported.
|
|
431
|
+
attr_reader :amount_type
|
|
432
|
+
# The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
433
|
+
attr_reader :purpose
|
|
434
|
+
|
|
435
|
+
def self.inner_class_types
|
|
436
|
+
@inner_class_types = {}
|
|
437
|
+
end
|
|
438
|
+
|
|
439
|
+
def self.field_remappings
|
|
440
|
+
@field_remappings = {}
|
|
441
|
+
end
|
|
442
|
+
end
|
|
443
|
+
# Attribute for field mandate_options
|
|
444
|
+
attr_reader :mandate_options
|
|
445
|
+
|
|
446
|
+
def self.inner_class_types
|
|
447
|
+
@inner_class_types = { mandate_options: MandateOptions }
|
|
448
|
+
end
|
|
449
|
+
|
|
450
|
+
def self.field_remappings
|
|
451
|
+
@field_remappings = {}
|
|
452
|
+
end
|
|
453
|
+
end
|
|
454
|
+
|
|
407
455
|
class Pix < ::Stripe::StripeObject
|
|
408
456
|
class MandateOptions < ::Stripe::StripeObject
|
|
409
457
|
# Amount to be charged for future payments.
|
|
@@ -532,6 +580,8 @@ module Stripe
|
|
|
532
580
|
attr_reader :id_bank_transfer
|
|
533
581
|
# This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.
|
|
534
582
|
attr_reader :konbini
|
|
583
|
+
# This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription.
|
|
584
|
+
attr_reader :payto
|
|
535
585
|
# This sub-hash contains details about the Pix payment method options to pass to invoices created by the subscription.
|
|
536
586
|
attr_reader :pix
|
|
537
587
|
# This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.
|
|
@@ -549,6 +599,7 @@ module Stripe
|
|
|
549
599
|
customer_balance: CustomerBalance,
|
|
550
600
|
id_bank_transfer: IdBankTransfer,
|
|
551
601
|
konbini: Konbini,
|
|
602
|
+
payto: Payto,
|
|
552
603
|
pix: Pix,
|
|
553
604
|
sepa_debit: SepaDebit,
|
|
554
605
|
upi: Upi,
|
|
@@ -602,7 +653,7 @@ module Stripe
|
|
|
602
653
|
attr_reader :subscription_items
|
|
603
654
|
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
|
|
604
655
|
attr_reader :trial_end
|
|
605
|
-
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/
|
|
656
|
+
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
|
|
606
657
|
attr_reader :trial_from_plan
|
|
607
658
|
|
|
608
659
|
def self.inner_class_types
|
|
@@ -680,7 +731,7 @@ module Stripe
|
|
|
680
731
|
attr_reader :automatic_tax
|
|
681
732
|
# The Billing Cadence which controls the timing of recurring invoice generation for this subscription.If unset, the subscription will bill according to its own configured schedule and create its own invoices.If set, this subscription will be billed by the cadence instead, potentially sharing invoices with the other subscriptions linked to that Cadence.
|
|
682
733
|
attr_reader :billing_cadence
|
|
683
|
-
# The reference point that aligns future [billing cycle](https://stripe.com/
|
|
734
|
+
# The reference point that aligns future [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.
|
|
684
735
|
attr_reader :billing_cycle_anchor
|
|
685
736
|
# The fixed values used to calculate the `billing_cycle_anchor`.
|
|
686
737
|
attr_reader :billing_cycle_anchor_config
|
|
@@ -706,13 +757,13 @@ module Stripe
|
|
|
706
757
|
attr_reader :currency
|
|
707
758
|
# ID of the customer who owns the subscription.
|
|
708
759
|
attr_reader :customer
|
|
709
|
-
# ID of the account who owns the subscription.
|
|
760
|
+
# ID of the account representing the customer who owns the subscription.
|
|
710
761
|
attr_reader :customer_account
|
|
711
762
|
# Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
|
|
712
763
|
attr_reader :days_until_due
|
|
713
|
-
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/
|
|
764
|
+
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
|
|
714
765
|
attr_reader :default_payment_method
|
|
715
|
-
# ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/
|
|
766
|
+
# ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
|
|
716
767
|
attr_reader :default_source
|
|
717
768
|
# The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
|
|
718
769
|
attr_reader :default_tax_rates
|
|
@@ -734,23 +785,23 @@ module Stripe
|
|
|
734
785
|
attr_reader :latest_invoice
|
|
735
786
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
736
787
|
attr_reader :livemode
|
|
737
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
788
|
+
# 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.
|
|
738
789
|
attr_reader :metadata
|
|
739
790
|
# Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
|
|
740
791
|
attr_reader :next_pending_invoice_item_invoice
|
|
741
792
|
# String representing the object's type. Objects of the same type share the same value.
|
|
742
793
|
attr_reader :object
|
|
743
|
-
# The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://stripe.com/
|
|
794
|
+
# The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) for details.
|
|
744
795
|
attr_reader :on_behalf_of
|
|
745
|
-
# 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/
|
|
796
|
+
# 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).
|
|
746
797
|
attr_reader :pause_collection
|
|
747
798
|
# Payment settings passed on to invoices created by the subscription.
|
|
748
799
|
attr_reader :payment_settings
|
|
749
|
-
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/
|
|
800
|
+
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval.
|
|
750
801
|
attr_reader :pending_invoice_item_interval
|
|
751
|
-
# You can use this [SetupIntent](https://stripe.com/
|
|
802
|
+
# You can use this [SetupIntent](https://docs.stripe.com/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2).
|
|
752
803
|
attr_reader :pending_setup_intent
|
|
753
|
-
# If specified, [pending updates](https://stripe.com/
|
|
804
|
+
# If specified, [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
|
|
754
805
|
attr_reader :pending_update
|
|
755
806
|
# Time period and invoice for a Subscription billed in advance.
|
|
756
807
|
attr_reader :prebilling
|
|
@@ -764,7 +815,7 @@ module Stripe
|
|
|
764
815
|
#
|
|
765
816
|
# A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over.
|
|
766
817
|
#
|
|
767
|
-
# A subscription can only enter a `paused` status [when a trial ends without a payment method](https://stripe.com/
|
|
818
|
+
# A subscription can only enter a `paused` status [when a trial ends without a payment method](https://docs.stripe.com/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged.
|
|
768
819
|
#
|
|
769
820
|
# If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings).
|
|
770
821
|
#
|
|
@@ -28,6 +28,23 @@ module Stripe
|
|
|
28
28
|
end
|
|
29
29
|
end
|
|
30
30
|
|
|
31
|
+
class CurrentTrial < ::Stripe::StripeObject
|
|
32
|
+
# Attribute for field end_date
|
|
33
|
+
attr_reader :end_date
|
|
34
|
+
# Attribute for field start_date
|
|
35
|
+
attr_reader :start_date
|
|
36
|
+
# Attribute for field trial_offer
|
|
37
|
+
attr_reader :trial_offer
|
|
38
|
+
|
|
39
|
+
def self.inner_class_types
|
|
40
|
+
@inner_class_types = {}
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
def self.field_remappings
|
|
44
|
+
@field_remappings = {}
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
|
|
31
48
|
class Trial < ::Stripe::StripeObject
|
|
32
49
|
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
|
|
33
50
|
attr_reader :converts_to
|
|
@@ -52,31 +69,33 @@ module Stripe
|
|
|
52
69
|
attr_reader :current_period_end
|
|
53
70
|
# The start time of this subscription item's current billing period.
|
|
54
71
|
attr_reader :current_period_start
|
|
72
|
+
# The current trial that is applied to this subscription item.
|
|
73
|
+
attr_reader :current_trial
|
|
55
74
|
# The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
|
|
56
75
|
attr_reader :discounts
|
|
57
76
|
# Unique identifier for the object.
|
|
58
77
|
attr_reader :id
|
|
59
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
78
|
+
# 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.
|
|
60
79
|
attr_reader :metadata
|
|
61
80
|
# String representing the object's type. Objects of the same type share the same value.
|
|
62
81
|
attr_reader :object
|
|
63
|
-
# You can now model subscriptions more flexibly using the [Prices API](https://stripe.com
|
|
82
|
+
# You can now model subscriptions more flexibly using the [Prices API](https://api.stripe.com#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
|
|
64
83
|
#
|
|
65
84
|
# Plans define the base price, currency, and billing cycle for recurring purchases of products.
|
|
66
|
-
# [Products](https://stripe.com
|
|
85
|
+
# [Products](https://api.stripe.com#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
|
|
67
86
|
#
|
|
68
87
|
# For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
|
|
69
88
|
#
|
|
70
|
-
# Related guides: [Set up a subscription](https://stripe.com/
|
|
89
|
+
# Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription) and more about [products and prices](https://docs.stripe.com/products-prices/overview).
|
|
71
90
|
attr_reader :plan
|
|
72
91
|
# Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.
|
|
73
|
-
# [Products](https://stripe.com
|
|
92
|
+
# [Products](https://api.stripe.com#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
|
|
74
93
|
#
|
|
75
94
|
# For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
|
|
76
95
|
#
|
|
77
|
-
# Related guides: [Set up a subscription](https://stripe.com/
|
|
96
|
+
# Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), [create an invoice](https://docs.stripe.com/billing/invoices/create), and more about [products and prices](https://docs.stripe.com/products-prices/overview).
|
|
78
97
|
attr_reader :price
|
|
79
|
-
# The [quantity](https://stripe.com/
|
|
98
|
+
# The [quantity](https://docs.stripe.com/subscriptions/quantities) of the plan to which the customer should be subscribed.
|
|
80
99
|
attr_reader :quantity
|
|
81
100
|
# The `subscription` this `subscription_item` belongs to.
|
|
82
101
|
attr_reader :subscription
|
|
@@ -138,7 +157,11 @@ module Stripe
|
|
|
138
157
|
end
|
|
139
158
|
|
|
140
159
|
def self.inner_class_types
|
|
141
|
-
@inner_class_types = {
|
|
160
|
+
@inner_class_types = {
|
|
161
|
+
billing_thresholds: BillingThresholds,
|
|
162
|
+
current_trial: CurrentTrial,
|
|
163
|
+
trial: Trial,
|
|
164
|
+
}
|
|
142
165
|
end
|
|
143
166
|
|
|
144
167
|
def self.field_remappings
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
module Stripe
|
|
5
5
|
# A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
|
|
6
6
|
#
|
|
7
|
-
# Related guide: [Subscription schedules](https://stripe.com/
|
|
7
|
+
# Related guide: [Subscription schedules](https://docs.stripe.com/billing/subscriptions/subscription-schedules)
|
|
8
8
|
class SubscriptionSchedule < APIResource
|
|
9
9
|
extend Stripe::APIOperations::Create
|
|
10
10
|
extend Stripe::APIOperations::List
|
|
@@ -44,6 +44,89 @@ module Stripe
|
|
|
44
44
|
end
|
|
45
45
|
end
|
|
46
46
|
|
|
47
|
+
class BillingSchedule < ::Stripe::StripeObject
|
|
48
|
+
class AppliesTo < ::Stripe::StripeObject
|
|
49
|
+
# The billing schedule will apply to the subscription item with the given price ID.
|
|
50
|
+
attr_reader :price
|
|
51
|
+
# Controls which subscription items the billing schedule applies to.
|
|
52
|
+
attr_reader :type
|
|
53
|
+
|
|
54
|
+
def self.inner_class_types
|
|
55
|
+
@inner_class_types = {}
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
def self.field_remappings
|
|
59
|
+
@field_remappings = {}
|
|
60
|
+
end
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
class BillFrom < ::Stripe::StripeObject
|
|
64
|
+
# The time the billing schedule applies from.
|
|
65
|
+
attr_reader :computed_timestamp
|
|
66
|
+
# Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
|
|
67
|
+
attr_reader :timestamp
|
|
68
|
+
# Describes how the billing schedule determines the start date. Possible values are `timestamp`.
|
|
69
|
+
attr_reader :type
|
|
70
|
+
|
|
71
|
+
def self.inner_class_types
|
|
72
|
+
@inner_class_types = {}
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
def self.field_remappings
|
|
76
|
+
@field_remappings = {}
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
class BillUntil < ::Stripe::StripeObject
|
|
81
|
+
class Duration < ::Stripe::StripeObject
|
|
82
|
+
# Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
83
|
+
attr_reader :interval
|
|
84
|
+
# The multiplier applied to the interval.
|
|
85
|
+
attr_reader :interval_count
|
|
86
|
+
|
|
87
|
+
def self.inner_class_types
|
|
88
|
+
@inner_class_types = {}
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
def self.field_remappings
|
|
92
|
+
@field_remappings = {}
|
|
93
|
+
end
|
|
94
|
+
end
|
|
95
|
+
# The timestamp the billing schedule will apply until.
|
|
96
|
+
attr_reader :computed_timestamp
|
|
97
|
+
# Specifies the billing period.
|
|
98
|
+
attr_reader :duration
|
|
99
|
+
# If specified, the billing schedule will apply until the specified timestamp.
|
|
100
|
+
attr_reader :timestamp
|
|
101
|
+
# Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
102
|
+
attr_reader :type
|
|
103
|
+
|
|
104
|
+
def self.inner_class_types
|
|
105
|
+
@inner_class_types = { duration: Duration }
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
def self.field_remappings
|
|
109
|
+
@field_remappings = {}
|
|
110
|
+
end
|
|
111
|
+
end
|
|
112
|
+
# Specifies which subscription items the billing schedule applies to.
|
|
113
|
+
attr_reader :applies_to
|
|
114
|
+
# Specifies the start of the billing period.
|
|
115
|
+
attr_reader :bill_from
|
|
116
|
+
# Specifies the end of billing period.
|
|
117
|
+
attr_reader :bill_until
|
|
118
|
+
# Unique identifier for the billing schedule.
|
|
119
|
+
attr_reader :key
|
|
120
|
+
|
|
121
|
+
def self.inner_class_types
|
|
122
|
+
@inner_class_types = { applies_to: AppliesTo, bill_from: BillFrom, bill_until: BillUntil }
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
def self.field_remappings
|
|
126
|
+
@field_remappings = {}
|
|
127
|
+
end
|
|
128
|
+
end
|
|
129
|
+
|
|
47
130
|
class CurrentPhase < ::Stripe::StripeObject
|
|
48
131
|
# The end of this phase of the subscription schedule.
|
|
49
132
|
attr_reader :end_date
|
|
@@ -155,7 +238,7 @@ module Stripe
|
|
|
155
238
|
attr_reader :application_fee_percent
|
|
156
239
|
# Attribute for field automatic_tax
|
|
157
240
|
attr_reader :automatic_tax
|
|
158
|
-
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/
|
|
241
|
+
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
|
|
159
242
|
attr_reader :billing_cycle_anchor
|
|
160
243
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
|
|
161
244
|
attr_reader :billing_thresholds
|
|
@@ -169,6 +252,8 @@ module Stripe
|
|
|
169
252
|
attr_reader :invoice_settings
|
|
170
253
|
# The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
|
|
171
254
|
attr_reader :on_behalf_of
|
|
255
|
+
# Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
256
|
+
attr_reader :phase_effective_at
|
|
172
257
|
# The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
|
|
173
258
|
attr_reader :transfer_data
|
|
174
259
|
|
|
@@ -297,7 +382,7 @@ module Stripe
|
|
|
297
382
|
end
|
|
298
383
|
# The stackable discounts that will be applied to the item.
|
|
299
384
|
attr_reader :discounts
|
|
300
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
385
|
+
# 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.
|
|
301
386
|
attr_reader :metadata
|
|
302
387
|
# Attribute for field period
|
|
303
388
|
attr_reader :period
|
|
@@ -492,7 +577,7 @@ module Stripe
|
|
|
492
577
|
attr_reader :billing_thresholds
|
|
493
578
|
# The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
|
|
494
579
|
attr_reader :discounts
|
|
495
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
580
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
|
|
496
581
|
attr_reader :metadata
|
|
497
582
|
# ID of the plan to which the customer should be subscribed.
|
|
498
583
|
attr_reader :plan
|
|
@@ -504,6 +589,8 @@ module Stripe
|
|
|
504
589
|
attr_reader :tax_rates
|
|
505
590
|
# Options that configure the trial on the subscription item.
|
|
506
591
|
attr_reader :trial
|
|
592
|
+
# The ID of the trial offer to apply to the configuration item.
|
|
593
|
+
attr_reader :trial_offer
|
|
507
594
|
|
|
508
595
|
def self.inner_class_types
|
|
509
596
|
@inner_class_types = {
|
|
@@ -576,7 +663,7 @@ module Stripe
|
|
|
576
663
|
attr_reader :application_fee_percent
|
|
577
664
|
# Attribute for field automatic_tax
|
|
578
665
|
attr_reader :automatic_tax
|
|
579
|
-
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/
|
|
666
|
+
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
|
|
580
667
|
attr_reader :billing_cycle_anchor
|
|
581
668
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
|
|
582
669
|
attr_reader :billing_thresholds
|
|
@@ -592,17 +679,19 @@ module Stripe
|
|
|
592
679
|
attr_reader :description
|
|
593
680
|
# The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
|
|
594
681
|
attr_reader :discounts
|
|
682
|
+
# Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
683
|
+
attr_reader :effective_at
|
|
595
684
|
# The end of this phase of the subscription schedule.
|
|
596
685
|
attr_reader :end_date
|
|
597
686
|
# The invoice settings applicable during this phase.
|
|
598
687
|
attr_reader :invoice_settings
|
|
599
688
|
# Subscription items to configure the subscription to during this phase of the subscription schedule.
|
|
600
689
|
attr_reader :items
|
|
601
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
690
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.
|
|
602
691
|
attr_reader :metadata
|
|
603
692
|
# The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
|
|
604
693
|
attr_reader :on_behalf_of
|
|
605
|
-
# 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/
|
|
694
|
+
# 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).
|
|
606
695
|
attr_reader :pause_collection
|
|
607
696
|
# When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
|
|
608
697
|
attr_reader :proration_behavior
|
|
@@ -660,6 +749,8 @@ module Stripe
|
|
|
660
749
|
attr_reader :billing_behavior
|
|
661
750
|
# The billing mode of the subscription.
|
|
662
751
|
attr_reader :billing_mode
|
|
752
|
+
# Billing schedules for this subscription schedule.
|
|
753
|
+
attr_reader :billing_schedules
|
|
663
754
|
# Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
|
|
664
755
|
attr_reader :canceled_at
|
|
665
756
|
# Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
|
|
@@ -680,9 +771,11 @@ module Stripe
|
|
|
680
771
|
attr_reader :id
|
|
681
772
|
# Details of the most recent price migration that failed for the subscription schedule.
|
|
682
773
|
attr_reader :last_price_migration_error
|
|
774
|
+
# The most recent invoice this subscription schedule has generated.
|
|
775
|
+
attr_reader :latest_invoice
|
|
683
776
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
684
777
|
attr_reader :livemode
|
|
685
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
778
|
+
# 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.
|
|
686
779
|
attr_reader :metadata
|
|
687
780
|
# String representing the object's type. Objects of the same type share the same value.
|
|
688
781
|
attr_reader :object
|
|
@@ -694,7 +787,7 @@ module Stripe
|
|
|
694
787
|
attr_reader :released_at
|
|
695
788
|
# ID of the subscription once managed by the subscription schedule (if it is released).
|
|
696
789
|
attr_reader :released_subscription
|
|
697
|
-
# The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/
|
|
790
|
+
# The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://docs.stripe.com/billing/subscriptions/subscription-schedules).
|
|
698
791
|
attr_reader :status
|
|
699
792
|
# ID of the subscription managed by the subscription schedule.
|
|
700
793
|
attr_reader :subscription
|
|
@@ -794,6 +887,7 @@ module Stripe
|
|
|
794
887
|
def self.inner_class_types
|
|
795
888
|
@inner_class_types = {
|
|
796
889
|
billing_mode: BillingMode,
|
|
890
|
+
billing_schedules: BillingSchedule,
|
|
797
891
|
current_phase: CurrentPhase,
|
|
798
892
|
default_settings: DefaultSettings,
|
|
799
893
|
last_price_migration_error: LastPriceMigrationError,
|
|
@@ -12,7 +12,7 @@ module Stripe
|
|
|
12
12
|
|
|
13
13
|
class TaxTransactionAttempt < ::Stripe::StripeObject
|
|
14
14
|
class Committed < ::Stripe::StripeObject
|
|
15
|
-
# The [Tax Transaction](https://stripe.com/
|
|
15
|
+
# The [Tax Transaction](https://docs.stripe.com/api/tax/transaction/object)
|
|
16
16
|
attr_reader :transaction
|
|
17
17
|
|
|
18
18
|
def self.inner_class_types
|
|
@@ -53,13 +53,13 @@ module Stripe
|
|
|
53
53
|
@field_remappings = {}
|
|
54
54
|
end
|
|
55
55
|
end
|
|
56
|
-
# The [Tax Calculation](https://stripe.com/
|
|
56
|
+
# The [Tax Calculation](https://docs.stripe.com/api/tax/calculations/object) that was included in PaymentIntent.
|
|
57
57
|
attr_reader :calculation
|
|
58
58
|
# Unique identifier for the object.
|
|
59
59
|
attr_reader :id
|
|
60
60
|
# String representing the object's type. Objects of the same type share the same value.
|
|
61
61
|
attr_reader :object
|
|
62
|
-
# The [PaymentIntent](https://stripe.com/
|
|
62
|
+
# The [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) that this Tax Association is tracking.
|
|
63
63
|
attr_reader :payment_intent
|
|
64
64
|
# Information about the tax transactions linked to this payment intent
|
|
65
65
|
attr_reader :tax_transaction_attempts
|
|
@@ -5,7 +5,7 @@ module Stripe
|
|
|
5
5
|
module Tax
|
|
6
6
|
# A Tax Calculation allows you to calculate the tax to collect from your customer.
|
|
7
7
|
#
|
|
8
|
-
# Related guide: [Calculate tax in your custom payment flow](https://stripe.com/
|
|
8
|
+
# Related guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom)
|
|
9
9
|
class Calculation < APIResource
|
|
10
10
|
extend Stripe::APIOperations::Create
|
|
11
11
|
|
|
@@ -144,7 +144,7 @@ module Stripe
|
|
|
144
144
|
@field_remappings = {}
|
|
145
145
|
end
|
|
146
146
|
end
|
|
147
|
-
# The amount of tax, in the [smallest currency unit](https://stripe.com/
|
|
147
|
+
# The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
148
148
|
attr_reader :amount
|
|
149
149
|
# Attribute for field jurisdiction
|
|
150
150
|
attr_reader :jurisdiction
|
|
@@ -154,7 +154,7 @@ module Stripe
|
|
|
154
154
|
attr_reader :tax_rate_details
|
|
155
155
|
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
|
|
156
156
|
attr_reader :taxability_reason
|
|
157
|
-
# The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/
|
|
157
|
+
# The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
158
158
|
attr_reader :taxable_amount
|
|
159
159
|
|
|
160
160
|
def self.inner_class_types
|
|
@@ -165,17 +165,17 @@ module Stripe
|
|
|
165
165
|
@field_remappings = {}
|
|
166
166
|
end
|
|
167
167
|
end
|
|
168
|
-
# The shipping amount in the [smallest currency unit](https://stripe.com/
|
|
168
|
+
# The shipping amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
|
|
169
169
|
attr_reader :amount
|
|
170
|
-
# The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/
|
|
170
|
+
# The amount of tax calculated for shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
171
171
|
attr_reader :amount_tax
|
|
172
|
-
# The ID of an existing [ShippingRate](https://stripe.com/
|
|
172
|
+
# The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object).
|
|
173
173
|
attr_reader :shipping_rate
|
|
174
174
|
# Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
|
|
175
175
|
attr_reader :tax_behavior
|
|
176
176
|
# Detailed account of taxes relevant to shipping cost.
|
|
177
177
|
attr_reader :tax_breakdown
|
|
178
|
-
# The [tax code](https://stripe.com/
|
|
178
|
+
# The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping.
|
|
179
179
|
attr_reader :tax_code
|
|
180
180
|
|
|
181
181
|
def self.inner_class_types
|
|
@@ -211,7 +211,7 @@ module Stripe
|
|
|
211
211
|
attr_reader :percentage_decimal
|
|
212
212
|
# Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.
|
|
213
213
|
attr_reader :rate_type
|
|
214
|
-
# State, county, province, or region.
|
|
214
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
215
215
|
attr_reader :state
|
|
216
216
|
# The tax type, such as `vat` or `sales_tax`.
|
|
217
217
|
attr_reader :tax_type
|
|
@@ -224,7 +224,7 @@ module Stripe
|
|
|
224
224
|
@field_remappings = {}
|
|
225
225
|
end
|
|
226
226
|
end
|
|
227
|
-
# The amount of tax, in the [smallest currency unit](https://stripe.com/
|
|
227
|
+
# The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
228
228
|
attr_reader :amount
|
|
229
229
|
# Specifies whether the tax amount is included in the line item amount.
|
|
230
230
|
attr_reader :inclusive
|
|
@@ -232,7 +232,7 @@ module Stripe
|
|
|
232
232
|
attr_reader :tax_rate_details
|
|
233
233
|
# The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules.
|
|
234
234
|
attr_reader :taxability_reason
|
|
235
|
-
# The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/
|
|
235
|
+
# The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
236
236
|
attr_reader :taxable_amount
|
|
237
237
|
|
|
238
238
|
def self.inner_class_types
|
|
@@ -243,11 +243,11 @@ module Stripe
|
|
|
243
243
|
@field_remappings = {}
|
|
244
244
|
end
|
|
245
245
|
end
|
|
246
|
-
# Total amount after taxes in the [smallest currency unit](https://stripe.com/
|
|
246
|
+
# Total amount after taxes in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
247
247
|
attr_reader :amount_total
|
|
248
248
|
# 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).
|
|
249
249
|
attr_reader :currency
|
|
250
|
-
# The ID of an existing [Customer](https://stripe.com/
|
|
250
|
+
# The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource.
|
|
251
251
|
attr_reader :customer
|
|
252
252
|
# Attribute for field customer_details
|
|
253
253
|
attr_reader :customer_details
|