stripe 18.1.0.pre.alpha.4 → 18.2.0.pre.alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/data/ca-certificates.crt +682 -518
- data/lib/stripe/api_requestor.rb +2 -0
- data/lib/stripe/api_version.rb +1 -1
- data/lib/stripe/errors.rb +3 -0
- data/lib/stripe/event_types.rb +56 -0
- data/lib/stripe/events/v2_core_health_api_error_firing_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_api_error_resolved_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_api_latency_firing_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_api_latency_resolved_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_payment_method_error_firing_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_payment_method_error_resolved_event.rb +19 -1
- data/lib/stripe/events/v2_core_health_sepa_debit_delayed_firing_event.rb +58 -0
- data/lib/stripe/events/v2_core_health_sepa_debit_delayed_resolved_event.rb +60 -0
- data/lib/stripe/events/v2_money_management_payout_method_created_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_canceled_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_created_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_errored_event.rb +65 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_funds_not_received_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_matched_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_not_found_event.rb +38 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_settled_event.rb +44 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_split_canceled_event.rb +61 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_split_created_event.rb +61 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_split_settled_event.rb +61 -0
- data/lib/stripe/events/v2_payments_settlement_allocation_intent_submitted_event.rb +44 -0
- data/lib/stripe/object_types.rb +6 -0
- data/lib/stripe/params/account_create_params.rb +50 -28
- data/lib/stripe/params/account_external_account_create_params.rb +2 -2
- data/lib/stripe/params/account_external_account_update_params.rb +2 -2
- data/lib/stripe/params/account_notice_update_params.rb +1 -1
- data/lib/stripe/params/account_person_create_params.rb +10 -10
- data/lib/stripe/params/account_person_update_params.rb +10 -10
- data/lib/stripe/params/account_session_create_params.rb +17 -0
- data/lib/stripe/params/account_update_params.rb +49 -27
- data/lib/stripe/params/application_fee_refund_create_params.rb +1 -1
- data/lib/stripe/params/application_fee_refund_update_params.rb +1 -1
- data/lib/stripe/params/balance_transfer_create_params.rb +1 -1
- data/lib/stripe/params/billing/credit_balance_summary_retrieve_params.rb +2 -2
- data/lib/stripe/params/billing/credit_balance_transaction_list_params.rb +2 -2
- data/lib/stripe/params/billing/credit_grant_create_params.rb +2 -2
- data/lib/stripe/params/billing/credit_grant_list_params.rb +1 -1
- data/lib/stripe/params/billing/meter_event_create_params.rb +1 -1
- data/lib/stripe/params/billing_portal/configuration_create_params.rb +7 -3
- data/lib/stripe/params/billing_portal/configuration_update_params.rb +7 -3
- data/lib/stripe/params/billing_portal/session_create_params.rb +7 -7
- data/lib/stripe/params/charge_capture_params.rb +9 -9
- data/lib/stripe/params/charge_create_params.rb +12 -12
- data/lib/stripe/params/charge_search_params.rb +1 -1
- data/lib/stripe/params/charge_update_params.rb +10 -10
- data/lib/stripe/params/checkout/session_create_params.rb +53 -41
- data/lib/stripe/params/checkout/session_update_params.rb +27 -15
- data/lib/stripe/params/climate/order_create_params.rb +1 -1
- data/lib/stripe/params/climate/order_update_params.rb +1 -1
- data/lib/stripe/params/confirmation_token_create_params.rb +6 -6
- data/lib/stripe/params/coupon_create_params.rb +1 -1
- data/lib/stripe/params/coupon_update_params.rb +1 -1
- data/lib/stripe/params/credit_note_create_params.rb +1 -1
- data/lib/stripe/params/credit_note_list_params.rb +1 -1
- data/lib/stripe/params/credit_note_list_preview_line_items_params.rb +1 -1
- data/lib/stripe/params/credit_note_preview_lines_list_params.rb +1 -1
- data/lib/stripe/params/credit_note_preview_params.rb +1 -1
- data/lib/stripe/params/credit_note_update_params.rb +1 -1
- data/lib/stripe/params/customer_balance_transaction_create_params.rb +2 -2
- data/lib/stripe/params/customer_balance_transaction_list_params.rb +11 -1
- data/lib/stripe/params/customer_balance_transaction_update_params.rb +1 -1
- data/lib/stripe/params/customer_cash_balance_update_params.rb +1 -1
- data/lib/stripe/params/customer_create_params.rb +5 -5
- data/lib/stripe/params/customer_fund_cash_balance_params.rb +2 -2
- data/lib/stripe/params/customer_payment_source_create_params.rb +2 -2
- data/lib/stripe/params/customer_payment_source_update_params.rb +2 -2
- data/lib/stripe/params/customer_search_params.rb +1 -1
- data/lib/stripe/params/customer_update_params.rb +7 -7
- data/lib/stripe/params/delegated_checkout/requested_session_confirm_params.rb +84 -1
- data/lib/stripe/params/dispute_update_params.rb +3 -3
- data/lib/stripe/params/external_account_create_params.rb +2 -2
- data/lib/stripe/params/external_account_update_params.rb +2 -2
- data/lib/stripe/params/file_create_params.rb +3 -3
- data/lib/stripe/params/file_link_create_params.rb +1 -1
- data/lib/stripe/params/file_link_update_params.rb +1 -1
- data/lib/stripe/params/financial_connections/account_list_params.rb +3 -3
- data/lib/stripe/params/financial_connections/session_create_params.rb +3 -3
- data/lib/stripe/params/forwarding/request_create_params.rb +1 -1
- data/lib/stripe/params/identity/verification_session_create_params.rb +6 -6
- data/lib/stripe/params/identity/verification_session_list_params.rb +3 -3
- data/lib/stripe/params/identity/verification_session_update_params.rb +5 -5
- data/lib/stripe/params/invoice_add_lines_params.rb +21 -9
- data/lib/stripe/params/invoice_attach_payment_params.rb +1 -1
- data/lib/stripe/params/invoice_create_params.rb +37 -13
- data/lib/stripe/params/invoice_create_preview_params.rb +60 -60
- data/lib/stripe/params/invoice_finalize_invoice_params.rb +1 -1
- data/lib/stripe/params/invoice_item_create_params.rb +8 -8
- data/lib/stripe/params/invoice_item_list_params.rb +2 -2
- data/lib/stripe/params/invoice_item_update_params.rb +6 -6
- data/lib/stripe/params/invoice_line_item_update_params.rb +20 -8
- data/lib/stripe/params/invoice_list_params.rb +2 -2
- data/lib/stripe/params/invoice_remove_lines_params.rb +1 -1
- data/lib/stripe/params/invoice_search_params.rb +1 -1
- data/lib/stripe/params/invoice_update_lines_params.rb +21 -9
- data/lib/stripe/params/invoice_update_params.rb +34 -10
- data/lib/stripe/params/issuing/authorization_approve_params.rb +2 -2
- data/lib/stripe/params/issuing/authorization_capture_params.rb +1 -1
- data/lib/stripe/params/issuing/authorization_create_params.rb +5 -5
- data/lib/stripe/params/issuing/authorization_decline_params.rb +1 -1
- data/lib/stripe/params/issuing/authorization_finalize_amount_params.rb +1 -1
- data/lib/stripe/params/issuing/authorization_increment_params.rb +2 -2
- data/lib/stripe/params/issuing/authorization_reverse_params.rb +1 -1
- data/lib/stripe/params/issuing/authorization_update_params.rb +1 -1
- data/lib/stripe/params/issuing/card_create_params.rb +7 -7
- data/lib/stripe/params/issuing/card_list_params.rb +34 -1
- data/lib/stripe/params/issuing/card_update_params.rb +6 -6
- data/lib/stripe/params/issuing/cardholder_create_params.rb +11 -11
- data/lib/stripe/params/issuing/cardholder_update_params.rb +10 -10
- data/lib/stripe/params/issuing/credit_underwriting_record_correct_params.rb +5 -5
- data/lib/stripe/params/issuing/credit_underwriting_record_create_from_application_params.rb +1 -1
- data/lib/stripe/params/issuing/credit_underwriting_record_create_from_proactive_review_params.rb +5 -5
- data/lib/stripe/params/issuing/credit_underwriting_record_report_decision_params.rb +4 -4
- data/lib/stripe/params/issuing/dispute_create_params.rb +2 -2
- data/lib/stripe/params/issuing/dispute_submit_params.rb +1 -1
- data/lib/stripe/params/issuing/dispute_update_params.rb +2 -2
- data/lib/stripe/params/issuing/personalization_design_create_params.rb +1 -1
- data/lib/stripe/params/issuing/personalization_design_update_params.rb +1 -1
- data/lib/stripe/params/issuing/program_update_params.rb +1 -1
- data/lib/stripe/params/issuing/transaction_create_force_capture_params.rb +2 -2
- data/lib/stripe/params/issuing/transaction_create_unlinked_refund_params.rb +2 -2
- data/lib/stripe/params/issuing/transaction_refund_params.rb +1 -1
- data/lib/stripe/params/issuing/transaction_update_params.rb +1 -1
- data/lib/stripe/params/mandate_list_params.rb +1 -1
- data/lib/stripe/params/margin_create_params.rb +1 -1
- data/lib/stripe/params/margin_update_params.rb +1 -1
- data/lib/stripe/params/order_create_params.rb +12 -12
- data/lib/stripe/params/order_update_params.rb +12 -12
- data/lib/stripe/params/payment_intent_apply_customer_balance_params.rb +1 -1
- data/lib/stripe/params/payment_intent_capture_params.rb +18 -18
- data/lib/stripe/params/payment_intent_confirm_params.rb +43 -39
- data/lib/stripe/params/payment_intent_create_params.rb +61 -57
- data/lib/stripe/params/payment_intent_decrement_authorization_params.rb +4 -4
- data/lib/stripe/params/payment_intent_increment_authorization_params.rb +10 -10
- data/lib/stripe/params/payment_intent_list_params.rb +1 -1
- data/lib/stripe/params/payment_intent_search_params.rb +1 -1
- data/lib/stripe/params/payment_intent_update_params.rb +40 -40
- data/lib/stripe/params/payment_link_create_params.rb +32 -20
- data/lib/stripe/params/payment_link_update_params.rb +9 -9
- data/lib/stripe/params/payment_method_attach_params.rb +1 -1
- data/lib/stripe/params/payment_method_configuration_create_params.rb +40 -40
- data/lib/stripe/params/payment_method_configuration_update_params.rb +40 -40
- data/lib/stripe/params/payment_method_create_params.rb +4 -4
- data/lib/stripe/params/payment_method_update_params.rb +2 -2
- data/lib/stripe/params/payment_record_report_payment_attempt_informational_params.rb +2 -2
- data/lib/stripe/params/payment_record_report_payment_attempt_params.rb +3 -3
- data/lib/stripe/params/payment_record_report_payment_params.rb +4 -4
- data/lib/stripe/params/payment_record_report_refund_params.rb +3 -3
- data/lib/stripe/params/payout_create_params.rb +1 -1
- data/lib/stripe/params/payout_reverse_params.rb +1 -1
- data/lib/stripe/params/payout_update_params.rb +1 -1
- data/lib/stripe/params/plan_create_params.rb +4 -4
- data/lib/stripe/params/plan_update_params.rb +2 -2
- data/lib/stripe/params/price_create_params.rb +6 -6
- data/lib/stripe/params/price_search_params.rb +1 -1
- data/lib/stripe/params/price_update_params.rb +3 -3
- data/lib/stripe/params/product_create_params.rb +21 -8
- data/lib/stripe/params/product_feature_create_params.rb +1 -1
- data/lib/stripe/params/product_list_params.rb +1 -1
- data/lib/stripe/params/product_search_params.rb +1 -1
- data/lib/stripe/params/product_update_params.rb +18 -5
- data/lib/stripe/params/promotion_code_create_params.rb +3 -3
- data/lib/stripe/params/promotion_code_list_params.rb +1 -1
- data/lib/stripe/params/promotion_code_update_params.rb +1 -1
- data/lib/stripe/params/quote_create_params.rb +14 -14
- data/lib/stripe/params/quote_list_params.rb +2 -2
- data/lib/stripe/params/quote_update_params.rb +14 -14
- data/lib/stripe/params/radar/value_list_create_params.rb +1 -1
- data/lib/stripe/params/radar/value_list_update_params.rb +1 -1
- data/lib/stripe/params/refund_create_params.rb +2 -2
- data/lib/stripe/params/refund_update_params.rb +1 -1
- data/lib/stripe/params/reporting/report_run_create_params.rb +2 -2
- data/lib/stripe/params/setup_intent_confirm_params.rb +6 -6
- data/lib/stripe/params/setup_intent_create_params.rb +12 -12
- data/lib/stripe/params/setup_intent_update_params.rb +8 -8
- data/lib/stripe/params/shared_payment/granted_token_create_params.rb +47 -0
- data/lib/stripe/params/shared_payment/granted_token_retrieve_params.rb +15 -0
- data/lib/stripe/params/shared_payment/granted_token_update_params.rb +15 -0
- data/lib/stripe/params/shipping_rate_create_params.rb +2 -2
- data/lib/stripe/params/shipping_rate_update_params.rb +1 -1
- data/lib/stripe/params/source_create_params.rb +3 -3
- data/lib/stripe/params/source_update_params.rb +3 -3
- data/lib/stripe/params/subscription_create_params.rb +51 -27
- data/lib/stripe/params/subscription_item_create_params.rb +15 -15
- data/lib/stripe/params/subscription_item_delete_params.rb +2 -2
- data/lib/stripe/params/subscription_item_update_params.rb +15 -15
- data/lib/stripe/params/subscription_list_params.rb +3 -3
- data/lib/stripe/params/subscription_resume_params.rb +2 -2
- data/lib/stripe/params/subscription_schedule_amend_params.rb +10 -10
- data/lib/stripe/params/subscription_schedule_create_params.rb +31 -31
- data/lib/stripe/params/subscription_schedule_update_params.rb +31 -31
- data/lib/stripe/params/subscription_search_params.rb +1 -1
- data/lib/stripe/params/subscription_update_params.rb +49 -25
- data/lib/stripe/params/tax/association_find_params.rb +1 -1
- data/lib/stripe/params/tax/calculation_create_params.rb +7 -7
- data/lib/stripe/params/tax/settings_update_params.rb +1 -1
- data/lib/stripe/params/tax/transaction_create_from_calculation_params.rb +1 -1
- data/lib/stripe/params/tax/transaction_create_reversal_params.rb +9 -9
- data/lib/stripe/params/tax_id_create_params.rb +2 -2
- data/lib/stripe/params/tax_id_list_params.rb +2 -2
- data/lib/stripe/params/tax_rate_create_params.rb +1 -1
- data/lib/stripe/params/tax_rate_update_params.rb +1 -1
- data/lib/stripe/params/terminal/location_create_params.rb +2 -2
- data/lib/stripe/params/terminal/location_update_params.rb +2 -2
- data/lib/stripe/params/terminal/reader_collect_inputs_params.rb +1 -1
- data/lib/stripe/params/terminal/reader_create_params.rb +1 -1
- data/lib/stripe/params/terminal/reader_refund_payment_params.rb +1 -1
- data/lib/stripe/params/terminal/reader_set_reader_display_params.rb +3 -3
- data/lib/stripe/params/terminal/reader_update_params.rb +1 -1
- data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +6 -6
- data/lib/stripe/params/test_helpers/customer_fund_cash_balance_params.rb +2 -2
- data/lib/stripe/params/test_helpers/issuing/authorization_capture_params.rb +1 -1
- data/lib/stripe/params/test_helpers/issuing/authorization_create_params.rb +5 -5
- data/lib/stripe/params/test_helpers/issuing/authorization_finalize_amount_params.rb +1 -1
- data/lib/stripe/params/test_helpers/issuing/authorization_increment_params.rb +2 -2
- data/lib/stripe/params/test_helpers/issuing/authorization_reverse_params.rb +1 -1
- data/lib/stripe/params/test_helpers/issuing/transaction_create_force_capture_params.rb +2 -2
- data/lib/stripe/params/test_helpers/issuing/transaction_create_unlinked_refund_params.rb +2 -2
- data/lib/stripe/params/test_helpers/issuing/transaction_refund_params.rb +1 -1
- data/lib/stripe/params/test_helpers/shared_payment/granted_token_create_params.rb +49 -0
- data/lib/stripe/params/test_helpers/shared_payment/granted_token_update_params.rb +17 -0
- data/lib/stripe/params/test_helpers/treasury/received_credit_create_params.rb +1 -1
- data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +1 -1
- data/lib/stripe/params/token_create_params.rb +22 -22
- data/lib/stripe/params/topup_create_params.rb +2 -2
- data/lib/stripe/params/topup_update_params.rb +1 -1
- data/lib/stripe/params/transfer_create_params.rb +3 -3
- data/lib/stripe/params/transfer_reversal_create_params.rb +1 -1
- data/lib/stripe/params/transfer_reversal_update_params.rb +1 -1
- data/lib/stripe/params/transfer_update_params.rb +1 -1
- data/lib/stripe/params/treasury/credit_reversal_create_params.rb +1 -1
- data/lib/stripe/params/treasury/debit_reversal_create_params.rb +1 -1
- data/lib/stripe/params/treasury/financial_account_create_params.rb +1 -1
- data/lib/stripe/params/treasury/financial_account_update_params.rb +1 -1
- data/lib/stripe/params/treasury/inbound_transfer_create_params.rb +2 -2
- data/lib/stripe/params/treasury/outbound_payment_create_params.rb +5 -5
- data/lib/stripe/params/treasury/outbound_transfer_create_params.rb +3 -3
- data/lib/stripe/params/treasury/received_credit_create_params.rb +1 -1
- data/lib/stripe/params/treasury/received_debit_create_params.rb +1 -1
- data/lib/stripe/params/v2/billing/intent_create_params.rb +110 -40
- data/lib/stripe/params/v2/core/account_create_params.rb +36 -24
- data/lib/stripe/params/v2/core/account_link_create_params.rb +5 -5
- data/lib/stripe/params/v2/core/account_token_create_params.rb +8 -8
- data/lib/stripe/params/v2/core/account_update_params.rb +41 -29
- data/lib/stripe/params/v2/core/accounts/person_create_params.rb +5 -5
- data/lib/stripe/params/v2/core/accounts/person_token_create_params.rb +5 -5
- data/lib/stripe/params/v2/core/accounts/person_update_params.rb +5 -5
- data/lib/stripe/params/v2/core/claimable_sandbox_create_params.rb +1 -1
- data/lib/stripe/params/v2/iam/api_key_create_params.rb +51 -0
- data/lib/stripe/params/v2/iam/api_key_expire_params.rb +10 -0
- data/lib/stripe/params/v2/iam/api_key_list_params.rb +20 -0
- data/lib/stripe/params/v2/iam/api_key_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/iam/api_key_rotate_params.rb +46 -0
- data/lib/stripe/params/v2/iam/api_key_update_params.rb +20 -0
- data/lib/stripe/params/v2/money_management/financial_account_list_params.rb +4 -1
- data/lib/stripe/params/v2/money_management/outbound_payment_create_params.rb +4 -1
- data/lib/stripe/params/v2/money_management/outbound_payment_quote_create_params.rb +4 -1
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_cancel_params.rb +10 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_create_params.rb +46 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_submit_params.rb +10 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intent_update_params.rb +31 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intents/split_cancel_params.rb +12 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intents/split_create_params.rb +39 -0
- data/lib/stripe/params/v2/payments/settlement_allocation_intents/split_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/tax/manual_rule_create_params.rb +94 -0
- data/lib/stripe/params/v2/tax/manual_rule_deactivate_params.rb +10 -0
- data/lib/stripe/params/v2/tax/manual_rule_list_params.rb +17 -0
- data/lib/stripe/params/v2/tax/manual_rule_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/tax/manual_rule_update_params.rb +94 -0
- data/lib/stripe/params/webhook_endpoint_create_params.rb +1 -1
- data/lib/stripe/params/webhook_endpoint_update_params.rb +1 -1
- data/lib/stripe/params.rb +24 -0
- data/lib/stripe/resources/account.rb +27 -27
- data/lib/stripe/resources/account_link.rb +1 -1
- data/lib/stripe/resources/account_notice.rb +6 -6
- data/lib/stripe/resources/account_session.rb +5 -5
- data/lib/stripe/resources/application_fee_refund.rb +2 -2
- data/lib/stripe/resources/apps/secret.rb +1 -1
- data/lib/stripe/resources/balance.rb +2 -2
- data/lib/stripe/resources/balance_settings.rb +1 -1
- data/lib/stripe/resources/balance_transaction.rb +1 -1
- data/lib/stripe/resources/balance_transfer.rb +3 -3
- data/lib/stripe/resources/bank_account.rb +10 -10
- data/lib/stripe/resources/billing/alert.rb +2 -2
- data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -2
- data/lib/stripe/resources/billing/credit_balance_transaction.rb +2 -2
- data/lib/stripe/resources/billing/credit_grant.rb +3 -3
- data/lib/stripe/resources/billing/meter_event.rb +1 -1
- data/lib/stripe/resources/billing_portal/configuration.rb +5 -3
- data/lib/stripe/resources/billing_portal/session.rb +6 -6
- data/lib/stripe/resources/capability.rb +16 -16
- data/lib/stripe/resources/capital/financing_offer.rb +2 -2
- data/lib/stripe/resources/capital/financing_summary.rb +7 -4
- data/lib/stripe/resources/card.rb +2 -2
- data/lib/stripe/resources/cash_balance.rb +2 -2
- data/lib/stripe/resources/charge.rb +47 -35
- data/lib/stripe/resources/checkout/session.rb +19 -19
- data/lib/stripe/resources/climate/order.rb +1 -1
- data/lib/stripe/resources/confirmation_token.rb +11 -11
- data/lib/stripe/resources/coupon.rb +3 -3
- data/lib/stripe/resources/credit_note.rb +5 -5
- data/lib/stripe/resources/credit_note_line_item.rb +1 -1
- data/lib/stripe/resources/customer.rb +8 -8
- data/lib/stripe/resources/customer_balance_transaction.rb +6 -6
- data/lib/stripe/resources/customer_cash_balance_transaction.rb +10 -10
- data/lib/stripe/resources/delegated_checkout/requested_session.rb +63 -10
- data/lib/stripe/resources/discount.rb +5 -5
- data/lib/stripe/resources/dispute.rb +5 -5
- data/lib/stripe/resources/entitlements/active_entitlement.rb +1 -1
- data/lib/stripe/resources/event.rb +1 -1
- data/lib/stripe/resources/exchange_rate.rb +2 -2
- data/lib/stripe/resources/file.rb +4 -4
- data/lib/stripe/resources/file_link.rb +1 -1
- data/lib/stripe/resources/financial_connections/account.rb +3 -3
- data/lib/stripe/resources/financial_connections/session.rb +2 -2
- data/lib/stripe/resources/forwarding/request.rb +1 -1
- data/lib/stripe/resources/funding_instructions.rb +14 -14
- data/lib/stripe/resources/identity/blocklist_entry.rb +1 -1
- data/lib/stripe/resources/identity/verification_report.rb +9 -9
- data/lib/stripe/resources/identity/verification_session.rb +11 -11
- data/lib/stripe/resources/invoice.rb +66 -34
- data/lib/stripe/resources/invoice_item.rb +9 -9
- data/lib/stripe/resources/invoice_line_item.rb +7 -7
- data/lib/stripe/resources/invoice_payment.rb +1 -1
- data/lib/stripe/resources/invoice_rendering_template.rb +1 -1
- data/lib/stripe/resources/issuing/authorization.rb +20 -20
- data/lib/stripe/resources/issuing/card.rb +16 -12
- data/lib/stripe/resources/issuing/cardholder.rb +14 -14
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +5 -5
- data/lib/stripe/resources/issuing/dispute.rb +7 -7
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +1 -1
- data/lib/stripe/resources/issuing/personalization_design.rb +1 -1
- data/lib/stripe/resources/issuing/program.rb +1 -1
- data/lib/stripe/resources/issuing/settlement.rb +2 -2
- data/lib/stripe/resources/issuing/token.rb +1 -1
- data/lib/stripe/resources/issuing/transaction.rb +13 -13
- data/lib/stripe/resources/line_item.rb +3 -3
- data/lib/stripe/resources/login_link.rb +1 -1
- data/lib/stripe/resources/margin.rb +1 -1
- data/lib/stripe/resources/order.rb +13 -13
- data/lib/stripe/resources/payment_attempt_record.rb +80 -22
- data/lib/stripe/resources/payment_intent.rb +117 -74
- data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +3 -3
- data/lib/stripe/resources/payment_link.rb +7 -7
- data/lib/stripe/resources/payment_method.rb +13 -13
- data/lib/stripe/resources/payment_method_configuration.rb +4 -4
- data/lib/stripe/resources/payment_method_domain.rb +1 -1
- data/lib/stripe/resources/payment_record.rb +82 -22
- data/lib/stripe/resources/payout.rb +7 -7
- data/lib/stripe/resources/person.rb +23 -23
- data/lib/stripe/resources/plan.rb +5 -5
- data/lib/stripe/resources/price.rb +6 -6
- data/lib/stripe/resources/product.rb +9 -9
- data/lib/stripe/resources/promotion_code.rb +4 -4
- data/lib/stripe/resources/quote.rb +15 -15
- data/lib/stripe/resources/quote_line.rb +5 -5
- data/lib/stripe/resources/quote_preview_invoice.rb +64 -32
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +100 -100
- data/lib/stripe/resources/radar/early_fraud_warning.rb +1 -1
- data/lib/stripe/resources/radar/value_list.rb +2 -2
- data/lib/stripe/resources/radar/value_list_item.rb +1 -1
- data/lib/stripe/resources/refund.rb +3 -3
- data/lib/stripe/resources/reporting/report_run.rb +3 -3
- data/lib/stripe/resources/reporting/report_type.rb +3 -3
- data/lib/stripe/resources/reversal.rb +4 -4
- data/lib/stripe/resources/review.rb +1 -1
- data/lib/stripe/resources/setup_attempt.rb +17 -17
- data/lib/stripe/resources/setup_intent.rb +19 -19
- data/lib/stripe/resources/shared_payment/granted_token.rb +126 -0
- data/lib/stripe/resources/shipping_rate.rb +3 -3
- data/lib/stripe/resources/sigma/scheduled_query_run.rb +1 -1
- data/lib/stripe/resources/source.rb +8 -8
- data/lib/stripe/resources/source_mandate_notification.rb +3 -3
- data/lib/stripe/resources/subscription.rb +46 -14
- data/lib/stripe/resources/subscription_item.rb +22 -22
- data/lib/stripe/resources/subscription_schedule.rb +101 -101
- data/lib/stripe/resources/tax/association.rb +3 -3
- data/lib/stripe/resources/tax/calculation.rb +12 -12
- data/lib/stripe/resources/tax/calculation_line_item.rb +7 -7
- data/lib/stripe/resources/tax/registration.rb +3 -3
- data/lib/stripe/resources/tax/settings.rb +2 -2
- data/lib/stripe/resources/tax/transaction.rb +9 -9
- data/lib/stripe/resources/tax/transaction_line_item.rb +5 -5
- data/lib/stripe/resources/tax_id.rb +4 -4
- data/lib/stripe/resources/tax_rate.rb +1 -1
- data/lib/stripe/resources/terminal/connection_token.rb +1 -1
- data/lib/stripe/resources/terminal/location.rb +3 -3
- data/lib/stripe/resources/terminal/reader.rb +10 -10
- data/lib/stripe/resources/token.rb +4 -4
- data/lib/stripe/resources/topup.rb +3 -3
- data/lib/stripe/resources/transfer.rb +5 -5
- data/lib/stripe/resources/treasury/credit_reversal.rb +3 -3
- data/lib/stripe/resources/treasury/debit_reversal.rb +3 -3
- data/lib/stripe/resources/treasury/financial_account.rb +1 -1
- data/lib/stripe/resources/treasury/inbound_transfer.rb +5 -5
- data/lib/stripe/resources/treasury/outbound_payment.rb +6 -6
- data/lib/stripe/resources/treasury/outbound_transfer.rb +5 -5
- data/lib/stripe/resources/treasury/received_credit.rb +10 -10
- data/lib/stripe/resources/treasury/received_debit.rb +7 -7
- data/lib/stripe/resources/treasury/transaction.rb +11 -11
- data/lib/stripe/resources/treasury/transaction_entry.rb +11 -11
- data/lib/stripe/resources/v2/billing/intent_action.rb +139 -51
- data/lib/stripe/resources/v2/core/account.rb +174 -289
- data/lib/stripe/resources/v2/core/account_link.rb +11 -11
- data/lib/stripe/resources/v2/core/account_person.rb +10 -10
- data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +21 -1
- data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +23 -1
- data/lib/stripe/resources/v2/iam/api_key.rb +129 -0
- data/lib/stripe/resources/v2/money_management/financial_account.rb +35 -0
- data/lib/stripe/resources/v2/money_management/outbound_payment.rb +2 -0
- data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +2 -0
- data/lib/stripe/resources/v2/money_management/payout_method.rb +20 -0
- data/lib/stripe/resources/v2/money_management/received_credit.rb +2 -0
- data/lib/stripe/resources/v2/payments/settlement_allocation_intent.rb +92 -0
- data/lib/stripe/resources/v2/payments/settlement_allocation_intent_split.rb +78 -0
- data/lib/stripe/resources/v2/tax/manual_rule.rb +115 -0
- data/lib/stripe/resources/webhook_endpoint.rb +1 -1
- data/lib/stripe/resources.rb +19 -0
- data/lib/stripe/services/capital/financing_summary_service.rb +1 -1
- data/lib/stripe/services/payment_method_service.rb +1 -1
- data/lib/stripe/services/shared_payment/granted_token_service.rb +19 -0
- data/lib/stripe/services/shared_payment_service.rb +13 -0
- data/lib/stripe/services/test_helpers/shared_payment/granted_token_service.rb +32 -0
- data/lib/stripe/services/test_helpers/shared_payment_service.rb +15 -0
- data/lib/stripe/services/test_helpers_service.rb +2 -1
- data/lib/stripe/services/v1_services.rb +2 -1
- data/lib/stripe/services/v2/core/account_link_service.rb +1 -1
- data/lib/stripe/services/v2/core/account_service.rb +0 -4
- data/lib/stripe/services/v2/core/accounts/person_service.rb +2 -2
- data/lib/stripe/services/v2/iam/api_key_service.rb +76 -0
- data/lib/stripe/services/v2/iam_service.rb +15 -0
- data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +2 -0
- data/lib/stripe/services/v2/money_management/payout_method_service.rb +2 -0
- data/lib/stripe/services/v2/payment_service.rb +3 -1
- data/lib/stripe/services/v2/payments/settlement_allocation_intent_service.rb +72 -0
- data/lib/stripe/services/v2/payments/settlement_allocation_intents/split_service.rb +45 -0
- data/lib/stripe/services/v2/tax/manual_rule_service.rb +65 -0
- data/lib/stripe/services/v2/tax_service.rb +15 -0
- data/lib/stripe/services/v2_services.rb +3 -1
- data/lib/stripe/services.rb +10 -0
- data/lib/stripe/stripe_object.rb +11 -3
- data/lib/stripe/version.rb +1 -1
- data/rbi/stripe.rbi +6022 -3221
- metadata +55 -2
|
@@ -5,7 +5,7 @@ module Stripe
|
|
|
5
5
|
class PayoutReverseParams < ::Stripe::RequestParams
|
|
6
6
|
# Specifies which fields in the response should be expanded.
|
|
7
7
|
attr_accessor :expand
|
|
8
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
8
|
+
# 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`.
|
|
9
9
|
attr_accessor :metadata
|
|
10
10
|
|
|
11
11
|
def initialize(expand: nil, metadata: nil)
|
|
@@ -5,7 +5,7 @@ module Stripe
|
|
|
5
5
|
class PayoutUpdateParams < ::Stripe::RequestParams
|
|
6
6
|
# Specifies which fields in the response should be expanded.
|
|
7
7
|
attr_accessor :expand
|
|
8
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
8
|
+
# 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`.
|
|
9
9
|
attr_accessor :metadata
|
|
10
10
|
|
|
11
11
|
def initialize(expand: nil, metadata: nil)
|
|
@@ -8,7 +8,7 @@ module Stripe
|
|
|
8
8
|
attr_accessor :active
|
|
9
9
|
# The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
|
|
10
10
|
attr_accessor :id
|
|
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 product's name, meant to be displayable to the customer.
|
|
14
14
|
attr_accessor :name
|
|
@@ -16,7 +16,7 @@ module Stripe
|
|
|
16
16
|
#
|
|
17
17
|
# This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
|
|
18
18
|
attr_accessor :statement_descriptor
|
|
19
|
-
# A [tax code](https://stripe.com/
|
|
19
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
20
20
|
attr_accessor :tax_code
|
|
21
21
|
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
22
22
|
attr_accessor :unit_label
|
|
@@ -96,7 +96,7 @@ module Stripe
|
|
|
96
96
|
attr_accessor :interval
|
|
97
97
|
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
|
98
98
|
attr_accessor :interval_count
|
|
99
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
99
|
+
# 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`.
|
|
100
100
|
attr_accessor :metadata
|
|
101
101
|
# The meter tracking the usage of a metered price
|
|
102
102
|
attr_accessor :meter
|
|
@@ -110,7 +110,7 @@ module Stripe
|
|
|
110
110
|
attr_accessor :tiers_mode
|
|
111
111
|
# Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
|
|
112
112
|
attr_accessor :transform_usage
|
|
113
|
-
# Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/
|
|
113
|
+
# Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan).
|
|
114
114
|
attr_accessor :trial_period_days
|
|
115
115
|
# Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
|
|
116
116
|
attr_accessor :usage_type
|
|
@@ -7,13 +7,13 @@ module Stripe
|
|
|
7
7
|
attr_accessor :active
|
|
8
8
|
# Specifies which fields in the response should be expanded.
|
|
9
9
|
attr_accessor :expand
|
|
10
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
10
|
+
# 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`.
|
|
11
11
|
attr_accessor :metadata
|
|
12
12
|
# A brief description of the plan, hidden from customers.
|
|
13
13
|
attr_accessor :nickname
|
|
14
14
|
# The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.
|
|
15
15
|
attr_accessor :product
|
|
16
|
-
# Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/
|
|
16
|
+
# Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan).
|
|
17
17
|
attr_accessor :trial_period_days
|
|
18
18
|
|
|
19
19
|
def initialize(
|
|
@@ -50,7 +50,7 @@ module Stripe
|
|
|
50
50
|
end
|
|
51
51
|
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
|
52
52
|
attr_accessor :custom_unit_amount
|
|
53
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
53
|
+
# 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.
|
|
54
54
|
attr_accessor :tax_behavior
|
|
55
55
|
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
|
|
56
56
|
attr_accessor :tiers
|
|
@@ -97,7 +97,7 @@ module Stripe
|
|
|
97
97
|
attr_accessor :active
|
|
98
98
|
# The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
|
|
99
99
|
attr_accessor :id
|
|
100
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
100
|
+
# 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`.
|
|
101
101
|
attr_accessor :metadata
|
|
102
102
|
# The product's name, meant to be displayable to the customer.
|
|
103
103
|
attr_accessor :name
|
|
@@ -105,7 +105,7 @@ module Stripe
|
|
|
105
105
|
#
|
|
106
106
|
# This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
|
|
107
107
|
attr_accessor :statement_descriptor
|
|
108
|
-
# A [tax code](https://stripe.com/
|
|
108
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
109
109
|
attr_accessor :tax_code
|
|
110
110
|
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
|
111
111
|
attr_accessor :unit_label
|
|
@@ -136,7 +136,7 @@ module Stripe
|
|
|
136
136
|
attr_accessor :interval_count
|
|
137
137
|
# The meter tracking the usage of a metered price
|
|
138
138
|
attr_accessor :meter
|
|
139
|
-
# Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/
|
|
139
|
+
# Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan).
|
|
140
140
|
attr_accessor :trial_period_days
|
|
141
141
|
# Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
|
|
142
142
|
attr_accessor :usage_type
|
|
@@ -208,7 +208,7 @@ module Stripe
|
|
|
208
208
|
attr_accessor :expand
|
|
209
209
|
# A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
|
|
210
210
|
attr_accessor :lookup_key
|
|
211
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
211
|
+
# 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`.
|
|
212
212
|
attr_accessor :metadata
|
|
213
213
|
# A brief description of the price, hidden from customers.
|
|
214
214
|
attr_accessor :nickname
|
|
@@ -218,7 +218,7 @@ module Stripe
|
|
|
218
218
|
attr_accessor :product_data
|
|
219
219
|
# The recurring components of a price such as `interval` and `usage_type`.
|
|
220
220
|
attr_accessor :recurring
|
|
221
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
221
|
+
# 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.
|
|
222
222
|
attr_accessor :tax_behavior
|
|
223
223
|
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
|
|
224
224
|
attr_accessor :tiers
|
|
@@ -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 prices](https://docs.stripe.com/search#query-fields-for-prices).
|
|
13
13
|
attr_accessor :query
|
|
14
14
|
|
|
15
15
|
def initialize(expand: nil, limit: nil, page: nil, query: nil)
|
|
@@ -50,7 +50,7 @@ module Stripe
|
|
|
50
50
|
end
|
|
51
51
|
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
|
52
52
|
attr_accessor :custom_unit_amount
|
|
53
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
53
|
+
# 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.
|
|
54
54
|
attr_accessor :tax_behavior
|
|
55
55
|
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
|
|
56
56
|
attr_accessor :tiers
|
|
@@ -96,13 +96,13 @@ module Stripe
|
|
|
96
96
|
attr_accessor :expand
|
|
97
97
|
# A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
|
|
98
98
|
attr_accessor :lookup_key
|
|
99
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
99
|
+
# 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`.
|
|
100
100
|
attr_accessor :metadata
|
|
101
101
|
# If specified, subscriptions using this price will be updated to use the new referenced price.
|
|
102
102
|
attr_accessor :migrate_to
|
|
103
103
|
# A brief description of the price, hidden from customers.
|
|
104
104
|
attr_accessor :nickname
|
|
105
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
105
|
+
# 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.
|
|
106
106
|
attr_accessor :tax_behavior
|
|
107
107
|
# If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
|
|
108
108
|
attr_accessor :transfer_lookup_key
|
|
@@ -51,7 +51,7 @@ module Stripe
|
|
|
51
51
|
end
|
|
52
52
|
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
|
53
53
|
attr_accessor :custom_unit_amount
|
|
54
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
54
|
+
# 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.
|
|
55
55
|
attr_accessor :tax_behavior
|
|
56
56
|
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
|
|
57
57
|
attr_accessor :tiers
|
|
@@ -110,11 +110,11 @@ module Stripe
|
|
|
110
110
|
attr_accessor :currency_options
|
|
111
111
|
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
|
112
112
|
attr_accessor :custom_unit_amount
|
|
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 recurring components of a price such as `interval` and `interval_count`.
|
|
116
116
|
attr_accessor :recurring
|
|
117
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
117
|
+
# 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.
|
|
118
118
|
attr_accessor :tax_behavior
|
|
119
119
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required.
|
|
120
120
|
attr_accessor :unit_amount
|
|
@@ -168,9 +168,18 @@ module Stripe
|
|
|
168
168
|
@width = width
|
|
169
169
|
end
|
|
170
170
|
end
|
|
171
|
+
|
|
172
|
+
class TaxDetails < ::Stripe::RequestParams
|
|
173
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
174
|
+
attr_accessor :tax_code
|
|
175
|
+
|
|
176
|
+
def initialize(tax_code: nil)
|
|
177
|
+
@tax_code = tax_code
|
|
178
|
+
end
|
|
179
|
+
end
|
|
171
180
|
# Whether the product is currently available for purchase. Defaults to `true`.
|
|
172
181
|
attr_accessor :active
|
|
173
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
182
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object. This Price will be set as the default price for this product.
|
|
174
183
|
attr_accessor :default_price_data
|
|
175
184
|
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
|
|
176
185
|
attr_accessor :description
|
|
@@ -180,9 +189,9 @@ module Stripe
|
|
|
180
189
|
attr_accessor :id
|
|
181
190
|
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
|
182
191
|
attr_accessor :images
|
|
183
|
-
# A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/
|
|
192
|
+
# A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table).
|
|
184
193
|
attr_accessor :marketing_features
|
|
185
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
194
|
+
# 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`.
|
|
186
195
|
attr_accessor :metadata
|
|
187
196
|
# The product's name, meant to be displayable to the customer.
|
|
188
197
|
attr_accessor :name
|
|
@@ -195,7 +204,7 @@ module Stripe
|
|
|
195
204
|
# This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
|
|
196
205
|
# It must contain at least one letter. Only used for subscription payments.
|
|
197
206
|
attr_accessor :statement_descriptor
|
|
198
|
-
# A [tax code](https://stripe.com/
|
|
207
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
199
208
|
attr_accessor :tax_code
|
|
200
209
|
# The type of the product. Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons.
|
|
201
210
|
attr_accessor :type
|
|
@@ -203,6 +212,8 @@ module Stripe
|
|
|
203
212
|
attr_accessor :unit_label
|
|
204
213
|
# A URL of a publicly-accessible webpage for this product.
|
|
205
214
|
attr_accessor :url
|
|
215
|
+
# Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.
|
|
216
|
+
attr_accessor :tax_details
|
|
206
217
|
|
|
207
218
|
def initialize(
|
|
208
219
|
active: nil,
|
|
@@ -220,7 +231,8 @@ module Stripe
|
|
|
220
231
|
tax_code: nil,
|
|
221
232
|
type: nil,
|
|
222
233
|
unit_label: nil,
|
|
223
|
-
url: nil
|
|
234
|
+
url: nil,
|
|
235
|
+
tax_details: nil
|
|
224
236
|
)
|
|
225
237
|
@active = active
|
|
226
238
|
@default_price_data = default_price_data
|
|
@@ -238,6 +250,7 @@ module Stripe
|
|
|
238
250
|
@type = type
|
|
239
251
|
@unit_label = unit_label
|
|
240
252
|
@url = url
|
|
253
|
+
@tax_details = tax_details
|
|
241
254
|
end
|
|
242
255
|
end
|
|
243
256
|
end
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
5
|
class ProductFeatureCreateParams < ::Stripe::RequestParams
|
|
6
|
-
# The ID of the [Feature](https://stripe.com/
|
|
6
|
+
# The ID of the [Feature](https://docs.stripe.com/api/entitlements/feature) object attached to this product.
|
|
7
7
|
attr_accessor :entitlement_feature
|
|
8
8
|
# Specifies which fields in the response should be expanded.
|
|
9
9
|
attr_accessor :expand
|
|
@@ -28,7 +28,7 @@ module Stripe
|
|
|
28
28
|
attr_accessor :ending_before
|
|
29
29
|
# Specifies which fields in the response should be expanded.
|
|
30
30
|
attr_accessor :expand
|
|
31
|
-
# Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com
|
|
31
|
+
# Only return products with the given IDs. Cannot be used with [starting_after](https://api.stripe.com#list_products-starting_after) or [ending_before](https://api.stripe.com#list_products-ending_before).
|
|
32
32
|
attr_accessor :ids
|
|
33
33
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
|
34
34
|
attr_accessor :limit
|
|
@@ -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 products](https://docs.stripe.com/search#query-fields-for-products).
|
|
13
13
|
attr_accessor :query
|
|
14
14
|
|
|
15
15
|
def initialize(expand: nil, limit: nil, page: nil, query: nil)
|
|
@@ -29,9 +29,18 @@ module Stripe
|
|
|
29
29
|
@width = width
|
|
30
30
|
end
|
|
31
31
|
end
|
|
32
|
+
|
|
33
|
+
class TaxDetails < ::Stripe::RequestParams
|
|
34
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
35
|
+
attr_accessor :tax_code
|
|
36
|
+
|
|
37
|
+
def initialize(tax_code: nil)
|
|
38
|
+
@tax_code = tax_code
|
|
39
|
+
end
|
|
40
|
+
end
|
|
32
41
|
# Whether the product is available for purchase.
|
|
33
42
|
attr_accessor :active
|
|
34
|
-
# The ID of the [Price](https://stripe.com/
|
|
43
|
+
# The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product.
|
|
35
44
|
attr_accessor :default_price
|
|
36
45
|
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
|
|
37
46
|
attr_accessor :description
|
|
@@ -39,9 +48,9 @@ module Stripe
|
|
|
39
48
|
attr_accessor :expand
|
|
40
49
|
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
|
41
50
|
attr_accessor :images
|
|
42
|
-
# A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/
|
|
51
|
+
# A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table).
|
|
43
52
|
attr_accessor :marketing_features
|
|
44
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
53
|
+
# 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`.
|
|
45
54
|
attr_accessor :metadata
|
|
46
55
|
# The product's name, meant to be displayable to the customer.
|
|
47
56
|
attr_accessor :name
|
|
@@ -54,12 +63,14 @@ module Stripe
|
|
|
54
63
|
# This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
|
|
55
64
|
# It must contain at least one letter. May only be set if `type=service`. Only used for subscription payments.
|
|
56
65
|
attr_accessor :statement_descriptor
|
|
57
|
-
# A [tax code](https://stripe.com/
|
|
66
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
58
67
|
attr_accessor :tax_code
|
|
59
68
|
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`.
|
|
60
69
|
attr_accessor :unit_label
|
|
61
70
|
# A URL of a publicly-accessible webpage for this product.
|
|
62
71
|
attr_accessor :url
|
|
72
|
+
# Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.
|
|
73
|
+
attr_accessor :tax_details
|
|
63
74
|
|
|
64
75
|
def initialize(
|
|
65
76
|
active: nil,
|
|
@@ -75,7 +86,8 @@ module Stripe
|
|
|
75
86
|
statement_descriptor: nil,
|
|
76
87
|
tax_code: nil,
|
|
77
88
|
unit_label: nil,
|
|
78
|
-
url: nil
|
|
89
|
+
url: nil,
|
|
90
|
+
tax_details: nil
|
|
79
91
|
)
|
|
80
92
|
@active = active
|
|
81
93
|
@default_price = default_price
|
|
@@ -91,6 +103,7 @@ module Stripe
|
|
|
91
103
|
@tax_code = tax_code
|
|
92
104
|
@unit_label = unit_label
|
|
93
105
|
@url = url
|
|
106
|
+
@tax_details = tax_details
|
|
94
107
|
end
|
|
95
108
|
end
|
|
96
109
|
end
|
|
@@ -51,9 +51,9 @@ module Stripe
|
|
|
51
51
|
#
|
|
52
52
|
# If left blank, we will generate one automatically.
|
|
53
53
|
attr_accessor :code
|
|
54
|
-
# The customer
|
|
54
|
+
# The customer who can use this promotion code. If not set, all customers can use the promotion code.
|
|
55
55
|
attr_accessor :customer
|
|
56
|
-
# The account
|
|
56
|
+
# The account representing the customer who can use this promotion code. If not set, all customers can use the promotion code.
|
|
57
57
|
attr_accessor :customer_account
|
|
58
58
|
# Specifies which fields in the response should be expanded.
|
|
59
59
|
attr_accessor :expand
|
|
@@ -61,7 +61,7 @@ module Stripe
|
|
|
61
61
|
attr_accessor :expires_at
|
|
62
62
|
# A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`.
|
|
63
63
|
attr_accessor :max_redemptions
|
|
64
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
64
|
+
# 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`.
|
|
65
65
|
attr_accessor :metadata
|
|
66
66
|
# The promotion referenced by this promotion code.
|
|
67
67
|
attr_accessor :promotion
|
|
@@ -30,7 +30,7 @@ module Stripe
|
|
|
30
30
|
attr_accessor :created
|
|
31
31
|
# Only return promotion codes that are restricted to this customer.
|
|
32
32
|
attr_accessor :customer
|
|
33
|
-
# Only return promotion codes that are restricted to this account.
|
|
33
|
+
# Only return promotion codes that are restricted to this account representing the customer.
|
|
34
34
|
attr_accessor :customer_account
|
|
35
35
|
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
|
36
36
|
attr_accessor :ending_before
|
|
@@ -23,7 +23,7 @@ module Stripe
|
|
|
23
23
|
attr_accessor :active
|
|
24
24
|
# Specifies which fields in the response should be expanded.
|
|
25
25
|
attr_accessor :expand
|
|
26
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
26
|
+
# 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`.
|
|
27
27
|
attr_accessor :metadata
|
|
28
28
|
# Settings that restrict the redemption of the promotion code.
|
|
29
29
|
attr_accessor :restrictions
|
|
@@ -198,7 +198,7 @@ module Stripe
|
|
|
198
198
|
end
|
|
199
199
|
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
200
200
|
attr_accessor :discounts
|
|
201
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
201
|
+
# 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`.
|
|
202
202
|
attr_accessor :metadata
|
|
203
203
|
# The ID of the price object.
|
|
204
204
|
attr_accessor :price
|
|
@@ -550,6 +550,8 @@ module Stripe
|
|
|
550
550
|
attr_accessor :billing_cycle_anchor
|
|
551
551
|
# A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
|
|
552
552
|
attr_accessor :cancel_subscription_schedule
|
|
553
|
+
# 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.
|
|
554
|
+
attr_accessor :effective_at
|
|
553
555
|
# Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
|
|
554
556
|
attr_accessor :ends_at
|
|
555
557
|
# Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
|
|
@@ -562,33 +564,31 @@ module Stripe
|
|
|
562
564
|
attr_accessor :starts_at
|
|
563
565
|
# Settings related to subscription trials.
|
|
564
566
|
attr_accessor :trial_settings
|
|
565
|
-
# 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.
|
|
566
|
-
attr_accessor :effective_at
|
|
567
567
|
|
|
568
568
|
def initialize(
|
|
569
569
|
actions: nil,
|
|
570
570
|
applies_to: nil,
|
|
571
571
|
billing_cycle_anchor: nil,
|
|
572
572
|
cancel_subscription_schedule: nil,
|
|
573
|
+
effective_at: nil,
|
|
573
574
|
ends_at: nil,
|
|
574
575
|
proration_behavior: nil,
|
|
575
576
|
set_pause_collection: nil,
|
|
576
577
|
set_schedule_end: nil,
|
|
577
578
|
starts_at: nil,
|
|
578
|
-
trial_settings: nil
|
|
579
|
-
effective_at: nil
|
|
579
|
+
trial_settings: nil
|
|
580
580
|
)
|
|
581
581
|
@actions = actions
|
|
582
582
|
@applies_to = applies_to
|
|
583
583
|
@billing_cycle_anchor = billing_cycle_anchor
|
|
584
584
|
@cancel_subscription_schedule = cancel_subscription_schedule
|
|
585
|
+
@effective_at = effective_at
|
|
585
586
|
@ends_at = ends_at
|
|
586
587
|
@proration_behavior = proration_behavior
|
|
587
588
|
@set_pause_collection = set_pause_collection
|
|
588
589
|
@set_schedule_end = set_schedule_end
|
|
589
590
|
@starts_at = starts_at
|
|
590
591
|
@trial_settings = trial_settings
|
|
591
|
-
@effective_at = effective_at
|
|
592
592
|
end
|
|
593
593
|
end
|
|
594
594
|
|
|
@@ -654,7 +654,7 @@ module Stripe
|
|
|
654
654
|
attr_accessor :product
|
|
655
655
|
# The recurring components of a price such as `interval` and `interval_count`.
|
|
656
656
|
attr_accessor :recurring
|
|
657
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
657
|
+
# 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.
|
|
658
658
|
attr_accessor :tax_behavior
|
|
659
659
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
|
660
660
|
attr_accessor :unit_amount
|
|
@@ -681,7 +681,7 @@ module Stripe
|
|
|
681
681
|
attr_accessor :discounts
|
|
682
682
|
# The ID of the price object. One of `price` or `price_data` is required.
|
|
683
683
|
attr_accessor :price
|
|
684
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
684
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
685
685
|
attr_accessor :price_data
|
|
686
686
|
# The quantity of the line item.
|
|
687
687
|
attr_accessor :quantity
|
|
@@ -918,17 +918,17 @@ module Stripe
|
|
|
918
918
|
attr_accessor :end_behavior
|
|
919
919
|
# The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden.
|
|
920
920
|
attr_accessor :from_subscription
|
|
921
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
921
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
922
922
|
attr_accessor :metadata
|
|
923
923
|
# Configures how the subscription schedule handles billing for phase transitions when the quote is accepted. 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.
|
|
924
924
|
attr_accessor :phase_effective_at
|
|
925
925
|
# If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
|
|
926
926
|
attr_accessor :prebilling
|
|
927
|
-
# Determines how to handle [prorations](https://stripe.com/
|
|
927
|
+
# Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
928
928
|
#
|
|
929
929
|
# When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
930
930
|
#
|
|
931
|
-
# Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/
|
|
931
|
+
# Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
|
|
932
932
|
#
|
|
933
933
|
# Prorations can be disabled by passing `none`.
|
|
934
934
|
attr_accessor :proration_behavior
|
|
@@ -1173,11 +1173,11 @@ module Stripe
|
|
|
1173
1173
|
attr_accessor :end_behavior
|
|
1174
1174
|
# Configures how the subscription schedule handles billing for phase transitions when the quote is accepted. 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.
|
|
1175
1175
|
attr_accessor :phase_effective_at
|
|
1176
|
-
# Determines how to handle [prorations](https://stripe.com/
|
|
1176
|
+
# Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
1177
1177
|
#
|
|
1178
1178
|
# When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
1179
1179
|
#
|
|
1180
|
-
# Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/
|
|
1180
|
+
# Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
|
|
1181
1181
|
#
|
|
1182
1182
|
# Prorations can be disabled by passing `none`.
|
|
1183
1183
|
attr_accessor :proration_behavior
|
|
@@ -1255,7 +1255,7 @@ module Stripe
|
|
|
1255
1255
|
attr_accessor :line_items
|
|
1256
1256
|
# A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
|
|
1257
1257
|
attr_accessor :lines
|
|
1258
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
1258
|
+
# 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`.
|
|
1259
1259
|
attr_accessor :metadata
|
|
1260
1260
|
# The account on behalf of which to charge.
|
|
1261
1261
|
attr_accessor :on_behalf_of
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
5
|
class QuoteListParams < ::Stripe::RequestParams
|
|
6
|
-
# The ID of the customer whose quotes
|
|
6
|
+
# The ID of the customer whose quotes you're retrieving.
|
|
7
7
|
attr_accessor :customer
|
|
8
|
-
# The ID of the account whose quotes
|
|
8
|
+
# The ID of the account representing the customer whose quotes you're retrieving.
|
|
9
9
|
attr_accessor :customer_account
|
|
10
10
|
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
|
11
11
|
attr_accessor :ending_before
|