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
|
@@ -3,6 +3,58 @@
|
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
5
|
class SubscriptionScheduleUpdateParams < ::Stripe::RequestParams
|
|
6
|
+
class BillingSchedule < ::Stripe::RequestParams
|
|
7
|
+
class AppliesTo < ::Stripe::RequestParams
|
|
8
|
+
# The ID of the price object.
|
|
9
|
+
attr_accessor :price
|
|
10
|
+
# Controls which subscription items the billing schedule applies to.
|
|
11
|
+
attr_accessor :type
|
|
12
|
+
|
|
13
|
+
def initialize(price: nil, type: nil)
|
|
14
|
+
@price = price
|
|
15
|
+
@type = type
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
class BillUntil < ::Stripe::RequestParams
|
|
20
|
+
class Duration < ::Stripe::RequestParams
|
|
21
|
+
# Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
22
|
+
attr_accessor :interval
|
|
23
|
+
# The multiplier applied to the interval.
|
|
24
|
+
attr_accessor :interval_count
|
|
25
|
+
|
|
26
|
+
def initialize(interval: nil, interval_count: nil)
|
|
27
|
+
@interval = interval
|
|
28
|
+
@interval_count = interval_count
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
# Specifies the billing period.
|
|
32
|
+
attr_accessor :duration
|
|
33
|
+
# The end date of the billing schedule.
|
|
34
|
+
attr_accessor :timestamp
|
|
35
|
+
# Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
36
|
+
attr_accessor :type
|
|
37
|
+
|
|
38
|
+
def initialize(duration: nil, timestamp: nil, type: nil)
|
|
39
|
+
@duration = duration
|
|
40
|
+
@timestamp = timestamp
|
|
41
|
+
@type = type
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
# Configure billing schedule differently for individual subscription items.
|
|
45
|
+
attr_accessor :applies_to
|
|
46
|
+
# The end date for the billing schedule.
|
|
47
|
+
attr_accessor :bill_until
|
|
48
|
+
# Specify a key for the billing schedule. Must be unique to this field, alphanumeric, and up to 200 characters. If not provided, a unique key will be generated.
|
|
49
|
+
attr_accessor :key
|
|
50
|
+
|
|
51
|
+
def initialize(applies_to: nil, bill_until: nil, key: nil)
|
|
52
|
+
@applies_to = applies_to
|
|
53
|
+
@bill_until = bill_until
|
|
54
|
+
@key = key
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
|
|
6
58
|
class DefaultSettings < ::Stripe::RequestParams
|
|
7
59
|
class AutomaticTax < ::Stripe::RequestParams
|
|
8
60
|
class Liability < ::Stripe::RequestParams
|
|
@@ -80,7 +132,7 @@ module Stripe
|
|
|
80
132
|
attr_accessor :application_fee_percent
|
|
81
133
|
# Default settings for automatic tax computation.
|
|
82
134
|
attr_accessor :automatic_tax
|
|
83
|
-
# Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/
|
|
135
|
+
# Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
|
|
84
136
|
attr_accessor :billing_cycle_anchor
|
|
85
137
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
|
|
86
138
|
attr_accessor :billing_thresholds
|
|
@@ -94,6 +146,8 @@ module Stripe
|
|
|
94
146
|
attr_accessor :invoice_settings
|
|
95
147
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
96
148
|
attr_accessor :on_behalf_of
|
|
149
|
+
# 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.
|
|
150
|
+
attr_accessor :phase_effective_at
|
|
97
151
|
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
|
98
152
|
attr_accessor :transfer_data
|
|
99
153
|
|
|
@@ -107,6 +161,7 @@ module Stripe
|
|
|
107
161
|
description: nil,
|
|
108
162
|
invoice_settings: nil,
|
|
109
163
|
on_behalf_of: nil,
|
|
164
|
+
phase_effective_at: nil,
|
|
110
165
|
transfer_data: nil
|
|
111
166
|
)
|
|
112
167
|
@application_fee_percent = application_fee_percent
|
|
@@ -118,6 +173,7 @@ module Stripe
|
|
|
118
173
|
@description = description
|
|
119
174
|
@invoice_settings = invoice_settings
|
|
120
175
|
@on_behalf_of = on_behalf_of
|
|
176
|
+
@phase_effective_at = phase_effective_at
|
|
121
177
|
@transfer_data = transfer_data
|
|
122
178
|
end
|
|
123
179
|
end
|
|
@@ -207,7 +263,7 @@ module Stripe
|
|
|
207
263
|
attr_accessor :currency
|
|
208
264
|
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
|
|
209
265
|
attr_accessor :product
|
|
210
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
266
|
+
# Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
211
267
|
attr_accessor :tax_behavior
|
|
212
268
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
|
|
213
269
|
attr_accessor :unit_amount
|
|
@@ -230,13 +286,13 @@ module Stripe
|
|
|
230
286
|
end
|
|
231
287
|
# The coupons to redeem into discounts for the item.
|
|
232
288
|
attr_accessor :discounts
|
|
233
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
289
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
234
290
|
attr_accessor :metadata
|
|
235
291
|
# The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
|
|
236
292
|
attr_accessor :period
|
|
237
293
|
# The ID of the price object. One of `price` or `price_data` is required.
|
|
238
294
|
attr_accessor :price
|
|
239
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
295
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
240
296
|
attr_accessor :price_data
|
|
241
297
|
# Quantity for this item. Defaults to 1.
|
|
242
298
|
attr_accessor :quantity
|
|
@@ -380,7 +436,7 @@ module Stripe
|
|
|
380
436
|
|
|
381
437
|
class Item < ::Stripe::RequestParams
|
|
382
438
|
class BillingThresholds < ::Stripe::RequestParams
|
|
383
|
-
# Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/
|
|
439
|
+
# Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
|
384
440
|
attr_accessor :usage_gte
|
|
385
441
|
|
|
386
442
|
def initialize(usage_gte: nil)
|
|
@@ -449,7 +505,7 @@ module Stripe
|
|
|
449
505
|
attr_accessor :product
|
|
450
506
|
# The recurring components of a price such as `interval` and `interval_count`.
|
|
451
507
|
attr_accessor :recurring
|
|
452
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
508
|
+
# Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
453
509
|
attr_accessor :tax_behavior
|
|
454
510
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
|
455
511
|
attr_accessor :unit_amount
|
|
@@ -488,20 +544,22 @@ module Stripe
|
|
|
488
544
|
attr_accessor :billing_thresholds
|
|
489
545
|
# The coupons to redeem into discounts for the subscription item.
|
|
490
546
|
attr_accessor :discounts
|
|
491
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
547
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
|
|
492
548
|
attr_accessor :metadata
|
|
493
549
|
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
|
|
494
550
|
attr_accessor :plan
|
|
495
551
|
# The ID of the price object.
|
|
496
552
|
attr_accessor :price
|
|
497
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
553
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
|
|
498
554
|
attr_accessor :price_data
|
|
499
555
|
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
|
|
500
556
|
attr_accessor :quantity
|
|
501
|
-
# A list of [Tax Rate](https://stripe.com/
|
|
557
|
+
# A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
502
558
|
attr_accessor :tax_rates
|
|
503
559
|
# Options that configure the trial on the subscription item.
|
|
504
560
|
attr_accessor :trial
|
|
561
|
+
# The ID of the trial offer to apply to the configuration item.
|
|
562
|
+
attr_accessor :trial_offer
|
|
505
563
|
|
|
506
564
|
def initialize(
|
|
507
565
|
billing_thresholds: nil,
|
|
@@ -512,7 +570,8 @@ module Stripe
|
|
|
512
570
|
price_data: nil,
|
|
513
571
|
quantity: nil,
|
|
514
572
|
tax_rates: nil,
|
|
515
|
-
trial: nil
|
|
573
|
+
trial: nil,
|
|
574
|
+
trial_offer: nil
|
|
516
575
|
)
|
|
517
576
|
@billing_thresholds = billing_thresholds
|
|
518
577
|
@discounts = discounts
|
|
@@ -523,6 +582,7 @@ module Stripe
|
|
|
523
582
|
@quantity = quantity
|
|
524
583
|
@tax_rates = tax_rates
|
|
525
584
|
@trial = trial
|
|
585
|
+
@trial_offer = trial_offer
|
|
526
586
|
end
|
|
527
587
|
end
|
|
528
588
|
|
|
@@ -569,7 +629,7 @@ module Stripe
|
|
|
569
629
|
attr_accessor :application_fee_percent
|
|
570
630
|
# Automatic tax settings for this phase.
|
|
571
631
|
attr_accessor :automatic_tax
|
|
572
|
-
# Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/
|
|
632
|
+
# Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
|
|
573
633
|
attr_accessor :billing_cycle_anchor
|
|
574
634
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
|
|
575
635
|
attr_accessor :billing_thresholds
|
|
@@ -579,7 +639,7 @@ module Stripe
|
|
|
579
639
|
attr_accessor :currency
|
|
580
640
|
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
|
|
581
641
|
attr_accessor :default_payment_method
|
|
582
|
-
# A list of [Tax Rate](https://stripe.com/
|
|
642
|
+
# A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
|
|
583
643
|
attr_accessor :default_tax_rates
|
|
584
644
|
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
|
585
645
|
attr_accessor :description
|
|
@@ -587,19 +647,21 @@ module Stripe
|
|
|
587
647
|
attr_accessor :discounts
|
|
588
648
|
# The number of intervals the phase should last. If set, `end_date` must not be set.
|
|
589
649
|
attr_accessor :duration
|
|
590
|
-
#
|
|
650
|
+
# 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.
|
|
651
|
+
attr_accessor :effective_at
|
|
652
|
+
# The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
|
|
591
653
|
attr_accessor :end_date
|
|
592
654
|
# All invoices will be billed using the specified settings.
|
|
593
655
|
attr_accessor :invoice_settings
|
|
594
656
|
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
|
|
595
657
|
attr_accessor :items
|
|
596
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
658
|
+
# 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, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
|
|
597
659
|
attr_accessor :metadata
|
|
598
660
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
599
661
|
attr_accessor :on_behalf_of
|
|
600
|
-
# 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/
|
|
662
|
+
# 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).
|
|
601
663
|
attr_accessor :pause_collection
|
|
602
|
-
# Controls whether the subscription schedule should create [prorations](https://stripe.com/
|
|
664
|
+
# Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
|
|
603
665
|
attr_accessor :proration_behavior
|
|
604
666
|
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
|
|
605
667
|
attr_accessor :start_date
|
|
@@ -627,6 +689,7 @@ module Stripe
|
|
|
627
689
|
description: nil,
|
|
628
690
|
discounts: nil,
|
|
629
691
|
duration: nil,
|
|
692
|
+
effective_at: nil,
|
|
630
693
|
end_date: nil,
|
|
631
694
|
invoice_settings: nil,
|
|
632
695
|
items: nil,
|
|
@@ -653,6 +716,7 @@ module Stripe
|
|
|
653
716
|
@description = description
|
|
654
717
|
@discounts = discounts
|
|
655
718
|
@duration = duration
|
|
719
|
+
@effective_at = effective_at
|
|
656
720
|
@end_date = end_date
|
|
657
721
|
@invoice_settings = invoice_settings
|
|
658
722
|
@items = items
|
|
@@ -682,13 +746,15 @@ module Stripe
|
|
|
682
746
|
end
|
|
683
747
|
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
|
|
684
748
|
attr_accessor :billing_behavior
|
|
749
|
+
# Sets the billing schedules for the subscription schedule.
|
|
750
|
+
attr_accessor :billing_schedules
|
|
685
751
|
# Object representing the subscription schedule's default settings.
|
|
686
752
|
attr_accessor :default_settings
|
|
687
753
|
# Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
|
|
688
754
|
attr_accessor :end_behavior
|
|
689
755
|
# Specifies which fields in the response should be expanded.
|
|
690
756
|
attr_accessor :expand
|
|
691
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
757
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
692
758
|
attr_accessor :metadata
|
|
693
759
|
# List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.
|
|
694
760
|
attr_accessor :phases
|
|
@@ -699,6 +765,7 @@ module Stripe
|
|
|
699
765
|
|
|
700
766
|
def initialize(
|
|
701
767
|
billing_behavior: nil,
|
|
768
|
+
billing_schedules: nil,
|
|
702
769
|
default_settings: nil,
|
|
703
770
|
end_behavior: nil,
|
|
704
771
|
expand: nil,
|
|
@@ -708,6 +775,7 @@ module Stripe
|
|
|
708
775
|
proration_behavior: nil
|
|
709
776
|
)
|
|
710
777
|
@billing_behavior = billing_behavior
|
|
778
|
+
@billing_schedules = billing_schedules
|
|
711
779
|
@default_settings = default_settings
|
|
712
780
|
@end_behavior = end_behavior
|
|
713
781
|
@expand = expand
|
|
@@ -9,7 +9,7 @@ module Stripe
|
|
|
9
9
|
attr_accessor :limit
|
|
10
10
|
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
|
|
11
11
|
attr_accessor :page
|
|
12
|
-
# The search query string. See [search query language](https://stripe.com/
|
|
12
|
+
# The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for subscriptions](https://docs.stripe.com/search#query-fields-for-subscriptions).
|
|
13
13
|
attr_accessor :query
|
|
14
14
|
|
|
15
15
|
def initialize(expand: nil, limit: nil, page: nil, query: nil)
|
|
@@ -87,7 +87,7 @@ module Stripe
|
|
|
87
87
|
attr_accessor :currency
|
|
88
88
|
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
|
|
89
89
|
attr_accessor :product
|
|
90
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
90
|
+
# Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
91
91
|
attr_accessor :tax_behavior
|
|
92
92
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
|
|
93
93
|
attr_accessor :unit_amount
|
|
@@ -110,13 +110,13 @@ module Stripe
|
|
|
110
110
|
end
|
|
111
111
|
# The coupons to redeem into discounts for the item.
|
|
112
112
|
attr_accessor :discounts
|
|
113
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
113
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
114
114
|
attr_accessor :metadata
|
|
115
115
|
# The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
|
|
116
116
|
attr_accessor :period
|
|
117
117
|
# The ID of the price object. One of `price` or `price_data` is required.
|
|
118
118
|
attr_accessor :price
|
|
119
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
119
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
120
120
|
attr_accessor :price_data
|
|
121
121
|
# Quantity for this item. Defaults to 1.
|
|
122
122
|
attr_accessor :quantity
|
|
@@ -309,7 +309,7 @@ module Stripe
|
|
|
309
309
|
|
|
310
310
|
class Item < ::Stripe::RequestParams
|
|
311
311
|
class BillingThresholds < ::Stripe::RequestParams
|
|
312
|
-
# Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/
|
|
312
|
+
# Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
|
313
313
|
attr_accessor :usage_gte
|
|
314
314
|
|
|
315
315
|
def initialize(usage_gte: nil)
|
|
@@ -317,6 +317,18 @@ module Stripe
|
|
|
317
317
|
end
|
|
318
318
|
end
|
|
319
319
|
|
|
320
|
+
class CurrentTrial < ::Stripe::RequestParams
|
|
321
|
+
# Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.
|
|
322
|
+
attr_accessor :trial_end
|
|
323
|
+
# The ID of the trial offer to apply to the subscription item.
|
|
324
|
+
attr_accessor :trial_offer
|
|
325
|
+
|
|
326
|
+
def initialize(trial_end: nil, trial_offer: nil)
|
|
327
|
+
@trial_end = trial_end
|
|
328
|
+
@trial_offer = trial_offer
|
|
329
|
+
end
|
|
330
|
+
end
|
|
331
|
+
|
|
320
332
|
class Discount < ::Stripe::RequestParams
|
|
321
333
|
class DiscountEnd < ::Stripe::RequestParams
|
|
322
334
|
class Duration < ::Stripe::RequestParams
|
|
@@ -378,7 +390,7 @@ module Stripe
|
|
|
378
390
|
attr_accessor :product
|
|
379
391
|
# The recurring components of a price such as `interval` and `interval_count`.
|
|
380
392
|
attr_accessor :recurring
|
|
381
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
393
|
+
# Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
|
382
394
|
attr_accessor :tax_behavior
|
|
383
395
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
|
384
396
|
attr_accessor :unit_amount
|
|
@@ -405,28 +417,31 @@ module Stripe
|
|
|
405
417
|
attr_accessor :billing_thresholds
|
|
406
418
|
# Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
|
|
407
419
|
attr_accessor :clear_usage
|
|
420
|
+
# The trial offer to apply to this subscription item.
|
|
421
|
+
attr_accessor :current_trial
|
|
408
422
|
# A flag that, if set to `true`, will delete the specified item.
|
|
409
423
|
attr_accessor :deleted
|
|
410
424
|
# The coupons to redeem into discounts for the subscription item.
|
|
411
425
|
attr_accessor :discounts
|
|
412
426
|
# Subscription item to update.
|
|
413
427
|
attr_accessor :id
|
|
414
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
428
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
415
429
|
attr_accessor :metadata
|
|
416
430
|
# Plan ID for this item, as a string.
|
|
417
431
|
attr_accessor :plan
|
|
418
432
|
# The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
|
|
419
433
|
attr_accessor :price
|
|
420
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
434
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
421
435
|
attr_accessor :price_data
|
|
422
436
|
# Quantity for this item.
|
|
423
437
|
attr_accessor :quantity
|
|
424
|
-
# A list of [Tax Rate](https://stripe.com/
|
|
438
|
+
# A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
425
439
|
attr_accessor :tax_rates
|
|
426
440
|
|
|
427
441
|
def initialize(
|
|
428
442
|
billing_thresholds: nil,
|
|
429
443
|
clear_usage: nil,
|
|
444
|
+
current_trial: nil,
|
|
430
445
|
deleted: nil,
|
|
431
446
|
discounts: nil,
|
|
432
447
|
id: nil,
|
|
@@ -439,6 +454,7 @@ module Stripe
|
|
|
439
454
|
)
|
|
440
455
|
@billing_thresholds = billing_thresholds
|
|
441
456
|
@clear_usage = clear_usage
|
|
457
|
+
@current_trial = current_trial
|
|
442
458
|
@deleted = deleted
|
|
443
459
|
@discounts = discounts
|
|
444
460
|
@id = id
|
|
@@ -513,7 +529,7 @@ module Stripe
|
|
|
513
529
|
attr_accessor :mandate_options
|
|
514
530
|
# Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
|
|
515
531
|
attr_accessor :network
|
|
516
|
-
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/
|
|
532
|
+
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
|
517
533
|
attr_accessor :request_three_d_secure
|
|
518
534
|
|
|
519
535
|
def initialize(mandate_options: nil, network: nil, request_three_d_secure: nil)
|
|
@@ -557,6 +573,26 @@ module Stripe
|
|
|
557
573
|
class IdBankTransfer < ::Stripe::RequestParams; end
|
|
558
574
|
class Konbini < ::Stripe::RequestParams; end
|
|
559
575
|
|
|
576
|
+
class Payto < ::Stripe::RequestParams
|
|
577
|
+
class MandateOptions < ::Stripe::RequestParams
|
|
578
|
+
# The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
|
|
579
|
+
attr_accessor :amount
|
|
580
|
+
# The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
581
|
+
attr_accessor :purpose
|
|
582
|
+
|
|
583
|
+
def initialize(amount: nil, purpose: nil)
|
|
584
|
+
@amount = amount
|
|
585
|
+
@purpose = purpose
|
|
586
|
+
end
|
|
587
|
+
end
|
|
588
|
+
# Additional fields for Mandate creation.
|
|
589
|
+
attr_accessor :mandate_options
|
|
590
|
+
|
|
591
|
+
def initialize(mandate_options: nil)
|
|
592
|
+
@mandate_options = mandate_options
|
|
593
|
+
end
|
|
594
|
+
end
|
|
595
|
+
|
|
560
596
|
class Pix < ::Stripe::RequestParams
|
|
561
597
|
class MandateOptions < ::Stripe::RequestParams
|
|
562
598
|
# Amount to be charged for future payments. If not provided, defaults to 40000.
|
|
@@ -664,6 +700,8 @@ module Stripe
|
|
|
664
700
|
attr_accessor :id_bank_transfer
|
|
665
701
|
# This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
|
666
702
|
attr_accessor :konbini
|
|
703
|
+
# This sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
|
|
704
|
+
attr_accessor :payto
|
|
667
705
|
# This sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
|
|
668
706
|
attr_accessor :pix
|
|
669
707
|
# This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
|
|
@@ -680,6 +718,7 @@ module Stripe
|
|
|
680
718
|
customer_balance: nil,
|
|
681
719
|
id_bank_transfer: nil,
|
|
682
720
|
konbini: nil,
|
|
721
|
+
payto: nil,
|
|
683
722
|
pix: nil,
|
|
684
723
|
sepa_debit: nil,
|
|
685
724
|
upi: nil,
|
|
@@ -691,6 +730,7 @@ module Stripe
|
|
|
691
730
|
@customer_balance = customer_balance
|
|
692
731
|
@id_bank_transfer = id_bank_transfer
|
|
693
732
|
@konbini = konbini
|
|
733
|
+
@payto = payto
|
|
694
734
|
@pix = pix
|
|
695
735
|
@sepa_debit = sepa_debit
|
|
696
736
|
@upi = upi
|
|
@@ -775,7 +815,7 @@ module Stripe
|
|
|
775
815
|
attr_accessor :automatic_tax
|
|
776
816
|
# The Billing Cadence which controls the timing of recurring invoice generation for this subscription. If unset, the subscription will bill according to its own configured schedule and create its own invoices. If set, this subscription will be billed by the cadence instead, potentially sharing invoices with the other subscriptions linked to that Cadence.
|
|
777
817
|
attr_accessor :billing_cadence
|
|
778
|
-
# Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/
|
|
818
|
+
# Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
|
|
779
819
|
attr_accessor :billing_cycle_anchor
|
|
780
820
|
# Sets the billing schedules for the subscription.
|
|
781
821
|
attr_accessor :billing_schedules
|
|
@@ -791,9 +831,9 @@ module Stripe
|
|
|
791
831
|
attr_accessor :collection_method
|
|
792
832
|
# Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
|
|
793
833
|
attr_accessor :days_until_due
|
|
794
|
-
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/
|
|
834
|
+
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
|
|
795
835
|
attr_accessor :default_payment_method
|
|
796
|
-
# ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/
|
|
836
|
+
# ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
|
|
797
837
|
attr_accessor :default_source
|
|
798
838
|
# The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates.
|
|
799
839
|
attr_accessor :default_tax_rates
|
|
@@ -807,29 +847,29 @@ module Stripe
|
|
|
807
847
|
attr_accessor :invoice_settings
|
|
808
848
|
# A list of up to 20 subscription items, each with an attached price.
|
|
809
849
|
attr_accessor :items
|
|
810
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
850
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
811
851
|
attr_accessor :metadata
|
|
812
852
|
# Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
|
|
813
853
|
attr_accessor :off_session
|
|
814
854
|
# The account on behalf of which to charge, for each of the subscription's invoices.
|
|
815
855
|
attr_accessor :on_behalf_of
|
|
816
|
-
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/
|
|
856
|
+
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
|
|
817
857
|
attr_accessor :pause_collection
|
|
818
|
-
# Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/
|
|
858
|
+
# Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
|
|
819
859
|
#
|
|
820
|
-
# Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/
|
|
860
|
+
# Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
|
|
821
861
|
#
|
|
822
|
-
# Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/
|
|
862
|
+
# Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes).
|
|
823
863
|
#
|
|
824
864
|
# Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
|
|
825
865
|
attr_accessor :payment_behavior
|
|
826
866
|
# Payment settings to pass to invoices created by the subscription.
|
|
827
867
|
attr_accessor :payment_settings
|
|
828
|
-
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/
|
|
868
|
+
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval.
|
|
829
869
|
attr_accessor :pending_invoice_item_interval
|
|
830
870
|
# If specified, the invoicing for the given billing cycle iterations will be processed now.
|
|
831
871
|
attr_accessor :prebilling
|
|
832
|
-
# Determines how to handle [prorations](https://stripe.com/
|
|
872
|
+
# Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
|
|
833
873
|
attr_accessor :proration_behavior
|
|
834
874
|
# If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
|
|
835
875
|
attr_accessor :proration_date
|
|
@@ -837,7 +877,7 @@ module Stripe
|
|
|
837
877
|
attr_accessor :transfer_data
|
|
838
878
|
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, `trial_end` will override the default trial period of the plan the customer is being subscribed to. The `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
|
|
839
879
|
attr_accessor :trial_end
|
|
840
|
-
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/
|
|
880
|
+
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
|
|
841
881
|
attr_accessor :trial_from_plan
|
|
842
882
|
# Settings related to subscription trials.
|
|
843
883
|
attr_accessor :trial_settings
|
|
@@ -6,7 +6,7 @@ module Stripe
|
|
|
6
6
|
class AssociationFindParams < ::Stripe::RequestParams
|
|
7
7
|
# Specifies which fields in the response should be expanded.
|
|
8
8
|
attr_accessor :expand
|
|
9
|
-
# Valid [PaymentIntent](https://stripe.com/
|
|
9
|
+
# Valid [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) id
|
|
10
10
|
attr_accessor :payment_intent
|
|
11
11
|
|
|
12
12
|
def initialize(expand: nil, payment_intent: nil)
|
|
@@ -74,20 +74,20 @@ module Stripe
|
|
|
74
74
|
end
|
|
75
75
|
|
|
76
76
|
class LineItem < ::Stripe::RequestParams
|
|
77
|
-
# A positive integer representing the line item's total price in the [smallest currency unit](https://stripe.com/
|
|
77
|
+
# A positive integer representing the line item's total price in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
|
|
78
78
|
# If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.
|
|
79
79
|
attr_accessor :amount
|
|
80
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
80
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
81
81
|
attr_accessor :metadata
|
|
82
82
|
# If provided, the product's `tax_code` will be used as the line item's `tax_code`.
|
|
83
83
|
attr_accessor :product
|
|
84
84
|
# The number of units of the item being purchased. Used to calculate the per-unit price from the total `amount` for the line. For example, if `amount=100` and `quantity=4`, the calculated unit price is 25.
|
|
85
85
|
attr_accessor :quantity
|
|
86
|
-
# A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported [tax reports](https://stripe.com/
|
|
86
|
+
# A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported [tax reports](https://docs.stripe.com/tax/reports).
|
|
87
87
|
attr_accessor :reference
|
|
88
88
|
# Specifies whether the `amount` includes taxes. Defaults to `exclusive`.
|
|
89
89
|
attr_accessor :tax_behavior
|
|
90
|
-
# A [tax code](https://stripe.com/
|
|
90
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID to use for this line item. If not provided, we will use the tax code from the provided `product` param. If neither `tax_code` nor `product` is provided, we will use the default tax code from your Tax Settings.
|
|
91
91
|
attr_accessor :tax_code
|
|
92
92
|
|
|
93
93
|
def initialize(
|
|
@@ -149,13 +149,13 @@ module Stripe
|
|
|
149
149
|
end
|
|
150
150
|
|
|
151
151
|
class ShippingCost < ::Stripe::RequestParams
|
|
152
|
-
# A positive integer in the [smallest currency unit](https://stripe.com/
|
|
152
|
+
# A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) representing the shipping charge. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.
|
|
153
153
|
attr_accessor :amount
|
|
154
|
-
# If provided, the [shipping rate](https://stripe.com/
|
|
154
|
+
# If provided, the [shipping rate](https://docs.stripe.com/api/shipping_rates/object)'s `amount`, `tax_code` and `tax_behavior` are used. If you provide a shipping rate, then you cannot pass the `amount`, `tax_code`, or `tax_behavior` parameters.
|
|
155
155
|
attr_accessor :shipping_rate
|
|
156
156
|
# Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. Defaults to `exclusive`.
|
|
157
157
|
attr_accessor :tax_behavior
|
|
158
|
-
# The [tax code](https://stripe.com/
|
|
158
|
+
# The [tax code](https://docs.stripe.com/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](https://dashboard.stripe.com/settings/tax) is used.
|
|
159
159
|
attr_accessor :tax_code
|
|
160
160
|
|
|
161
161
|
def initialize(amount: nil, shipping_rate: nil, tax_behavior: nil, tax_code: nil)
|
|
@@ -7,7 +7,7 @@ module Stripe
|
|
|
7
7
|
class Defaults < ::Stripe::RequestParams
|
|
8
8
|
# Specifies the default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) to be used when the item's price has unspecified tax behavior. One of inclusive, exclusive, or inferred_by_currency. Once specified, it cannot be changed back to null.
|
|
9
9
|
attr_accessor :tax_behavior
|
|
10
|
-
# A [tax code](https://stripe.com/
|
|
10
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
11
11
|
attr_accessor :tax_code
|
|
12
12
|
|
|
13
13
|
def initialize(tax_behavior: nil, tax_code: nil)
|
|
@@ -8,7 +8,7 @@ module Stripe
|
|
|
8
8
|
attr_accessor :calculation
|
|
9
9
|
# Specifies which fields in the response should be expanded.
|
|
10
10
|
attr_accessor :expand
|
|
11
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
11
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
12
12
|
attr_accessor :metadata
|
|
13
13
|
# The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time.
|
|
14
14
|
attr_accessor :posted_at
|