stripe 17.0.0 → 17.1.0.pre.beta.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/stripe/api_requestor.rb +34 -0
- data/lib/stripe/api_version.rb +1 -2
- data/lib/stripe/errors.rb +63 -0
- data/lib/stripe/event_types.rb +236 -0
- data/lib/stripe/events/v2_billing_bill_setting_updated_event.rb +61 -0
- data/lib/stripe/events/v2_core_account_closed_event.rb +44 -0
- data/lib/stripe/events/v2_core_account_created_event.rb +44 -0
- data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +63 -0
- data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +44 -0
- data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +63 -0
- data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +44 -0
- data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +63 -0
- data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +44 -0
- data/lib/stripe/events/v2_core_account_including_configuration_storer_capability_status_updated_event.rb +63 -0
- data/lib/stripe/events/v2_core_account_including_configuration_storer_updated_event.rb +44 -0
- data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +44 -0
- data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +44 -0
- data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +44 -0
- data/lib/stripe/events/v2_core_account_link_returned_event.rb +42 -0
- data/lib/stripe/events/v2_core_account_person_created_event.rb +61 -0
- data/lib/stripe/events/v2_core_account_person_deleted_event.rb +61 -0
- data/lib/stripe/events/v2_core_account_person_updated_event.rb +61 -0
- data/lib/stripe/events/v2_core_account_updated_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +61 -0
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_payout_method_updated_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +61 -0
- data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_transaction_created_event.rb +44 -0
- data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +44 -0
- data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +44 -0
- data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +46 -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/object_types.rb +58 -0
- data/lib/stripe/params/account_create_params.rb +300 -1
- data/lib/stripe/params/account_notice_list_params.rb +25 -0
- data/lib/stripe/params/account_notice_retrieve_params.rb +13 -0
- data/lib/stripe/params/account_notice_update_params.rb +36 -0
- data/lib/stripe/params/account_session_create_params.rb +226 -1
- data/lib/stripe/params/account_update_params.rb +262 -0
- data/lib/stripe/params/billing/analytics/meter_usage_retrieve_params.rb +65 -0
- data/lib/stripe/params/billing/credit_balance_summary_retrieve_params.rb +4 -1
- data/lib/stripe/params/billing/credit_balance_transaction_list_params.rb +4 -0
- data/lib/stripe/params/billing/credit_grant_create_params.rb +4 -0
- data/lib/stripe/params/billing/credit_grant_list_params.rb +4 -0
- data/lib/stripe/params/billing_portal/session_create_params.rb +4 -0
- data/lib/stripe/params/capital/financing_offer_list_params.rb +58 -0
- data/lib/stripe/params/capital/financing_offer_mark_delivered_params.rb +15 -0
- data/lib/stripe/params/capital/financing_offer_retrieve_params.rb +15 -0
- data/lib/stripe/params/capital/financing_summary_retrieve_params.rb +15 -0
- data/lib/stripe/params/capital/financing_transaction_list_params.rb +45 -0
- data/lib/stripe/params/capital/financing_transaction_retrieve_params.rb +15 -0
- data/lib/stripe/params/charge_capture_params.rb +709 -0
- data/lib/stripe/params/charge_update_params.rb +709 -0
- data/lib/stripe/params/checkout/session_create_params.rb +193 -3
- data/lib/stripe/params/checkout/session_list_params.rb +4 -0
- data/lib/stripe/params/checkout/session_update_params.rb +288 -1
- data/lib/stripe/params/confirmation_token_create_params.rb +97 -0
- data/lib/stripe/params/coupon_create_params.rb +17 -1
- data/lib/stripe/params/credit_note_list_params.rb +4 -0
- data/lib/stripe/params/customer_session_create_params.rb +4 -1
- data/lib/stripe/params/dispute_update_params.rb +10 -1
- data/lib/stripe/params/external_account_create_params.rb +134 -0
- data/lib/stripe/params/external_account_delete_params.rb +6 -0
- data/lib/stripe/params/external_account_list_params.rb +25 -0
- data/lib/stripe/params/external_account_retrieve_params.rb +13 -0
- data/lib/stripe/params/external_account_update_params.rb +91 -0
- data/lib/stripe/params/financial_connections/account_inferred_balance_list_params.rb +24 -0
- data/lib/stripe/params/financial_connections/account_list_params.rb +4 -1
- data/lib/stripe/params/financial_connections/institution_list_params.rb +24 -0
- data/lib/stripe/params/financial_connections/institution_retrieve_params.rb +15 -0
- data/lib/stripe/params/financial_connections/session_create_params.rb +34 -2
- data/lib/stripe/params/fx_quote_create_params.rb +73 -0
- data/lib/stripe/params/fx_quote_list_params.rb +22 -0
- data/lib/stripe/params/fx_quote_retrieve_params.rb +13 -0
- data/lib/stripe/params/identity/verification_session_create_params.rb +4 -0
- data/lib/stripe/params/identity/verification_session_list_params.rb +4 -0
- data/lib/stripe/params/invoice_add_lines_params.rb +33 -1
- data/lib/stripe/params/invoice_attach_payment_params.rb +46 -1
- data/lib/stripe/params/invoice_create_params.rb +112 -2
- data/lib/stripe/params/invoice_create_preview_params.rb +826 -9
- data/lib/stripe/params/invoice_item_create_params.rb +37 -1
- data/lib/stripe/params/invoice_item_list_params.rb +4 -0
- data/lib/stripe/params/invoice_item_update_params.rb +33 -1
- data/lib/stripe/params/invoice_line_item_update_params.rb +33 -1
- data/lib/stripe/params/invoice_list_params.rb +4 -0
- data/lib/stripe/params/invoice_payment_list_params.rb +4 -1
- data/lib/stripe/params/invoice_update_lines_params.rb +33 -1
- data/lib/stripe/params/invoice_update_params.rb +108 -2
- data/lib/stripe/params/issuing/cardholder_create_params.rb +2 -1
- data/lib/stripe/params/issuing/credit_underwriting_record_correct_params.rb +163 -0
- data/lib/stripe/params/issuing/credit_underwriting_record_create_from_application_params.rb +50 -0
- data/lib/stripe/params/issuing/credit_underwriting_record_create_from_proactive_review_params.rb +128 -0
- data/lib/stripe/params/issuing/credit_underwriting_record_list_params.rb +24 -0
- data/lib/stripe/params/issuing/credit_underwriting_record_report_decision_params.rb +86 -0
- data/lib/stripe/params/issuing/credit_underwriting_record_retrieve_params.rb +15 -0
- data/lib/stripe/params/issuing/dispute_settlement_detail_list_params.rb +33 -0
- data/lib/stripe/params/issuing/dispute_settlement_detail_retrieve_params.rb +15 -0
- data/lib/stripe/params/issuing/fraud_liability_debit_list_params.rb +44 -0
- data/lib/stripe/params/issuing/fraud_liability_debit_retrieve_params.rb +15 -0
- data/lib/stripe/params/issuing/transaction_list_params.rb +4 -0
- data/lib/stripe/params/mandate_list_params.rb +39 -0
- data/lib/stripe/params/margin_create_params.rb +25 -0
- data/lib/stripe/params/margin_list_params.rb +25 -0
- data/lib/stripe/params/margin_retrieve_params.rb +13 -0
- data/lib/stripe/params/margin_update_params.rb +22 -0
- data/lib/stripe/params/order_cancel_params.rb +13 -0
- data/lib/stripe/params/order_create_params.rb +1124 -0
- data/lib/stripe/params/order_line_item_list_params.rb +22 -0
- data/lib/stripe/params/order_list_line_items_params.rb +22 -0
- data/lib/stripe/params/order_list_params.rb +25 -0
- data/lib/stripe/params/order_reopen_params.rb +13 -0
- data/lib/stripe/params/order_retrieve_params.rb +13 -0
- data/lib/stripe/params/order_submit_params.rb +16 -0
- data/lib/stripe/params/order_update_params.rb +1128 -0
- data/lib/stripe/params/payment_attempt_record_list_params.rb +19 -0
- data/lib/stripe/params/payment_attempt_record_retrieve_params.rb +13 -0
- data/lib/stripe/params/payment_intent_amount_details_line_item_list_params.rb +22 -0
- data/lib/stripe/params/payment_intent_capture_params.rb +895 -0
- data/lib/stripe/params/payment_intent_confirm_params.rb +1373 -7
- data/lib/stripe/params/payment_intent_create_params.rb +1387 -13
- data/lib/stripe/params/payment_intent_decrement_authorization_params.rb +73 -0
- data/lib/stripe/params/payment_intent_increment_authorization_params.rb +223 -0
- data/lib/stripe/params/payment_intent_list_params.rb +4 -0
- data/lib/stripe/params/payment_intent_trigger_action_params.rb +27 -0
- data/lib/stripe/params/payment_intent_update_params.rb +1409 -4
- data/lib/stripe/params/payment_method_attach_params.rb +4 -1
- data/lib/stripe/params/payment_method_configuration_create_params.rb +126 -0
- data/lib/stripe/params/payment_method_configuration_update_params.rb +126 -0
- data/lib/stripe/params/payment_method_create_params.rb +97 -0
- data/lib/stripe/params/payment_method_update_params.rb +19 -0
- data/lib/stripe/params/payment_record_report_payment_attempt_canceled_params.rb +19 -0
- data/lib/stripe/params/payment_record_report_payment_attempt_failed_params.rb +19 -0
- data/lib/stripe/params/payment_record_report_payment_attempt_guaranteed_params.rb +19 -0
- data/lib/stripe/params/payment_record_report_payment_attempt_informational_params.rb +93 -0
- data/lib/stripe/params/payment_record_report_payment_attempt_params.rb +186 -0
- data/lib/stripe/params/payment_record_report_payment_params.rb +252 -0
- data/lib/stripe/params/payment_record_retrieve_params.rb +13 -0
- data/lib/stripe/params/price_update_params.rb +19 -0
- data/lib/stripe/params/privacy/redaction_job_cancel_params.rb +15 -0
- data/lib/stripe/params/privacy/redaction_job_create_params.rb +67 -0
- data/lib/stripe/params/privacy/redaction_job_list_params.rb +27 -0
- data/lib/stripe/params/privacy/redaction_job_retrieve_params.rb +15 -0
- data/lib/stripe/params/privacy/redaction_job_run_params.rb +15 -0
- data/lib/stripe/params/privacy/redaction_job_update_params.rb +18 -0
- data/lib/stripe/params/privacy/redaction_job_validate_params.rb +15 -0
- data/lib/stripe/params/privacy/redaction_job_validation_error_list_params.rb +24 -0
- data/lib/stripe/params/promotion_code_create_params.rb +4 -0
- data/lib/stripe/params/promotion_code_list_params.rb +4 -0
- data/lib/stripe/params/quote_create_params.rb +805 -3
- data/lib/stripe/params/quote_line_list_params.rb +22 -0
- data/lib/stripe/params/quote_list_lines_params.rb +22 -0
- data/lib/stripe/params/quote_list_params.rb +8 -0
- data/lib/stripe/params/quote_list_preview_invoice_lines_params.rb +22 -0
- data/lib/stripe/params/quote_mark_draft_params.rb +13 -0
- data/lib/stripe/params/quote_mark_stale_params.rb +16 -0
- data/lib/stripe/params/quote_preview_invoice_list_params.rb +22 -0
- data/lib/stripe/params/quote_preview_subscription_schedule_list_params.rb +22 -0
- data/lib/stripe/params/quote_reestimate_params.rb +13 -0
- data/lib/stripe/params/quote_update_params.rb +813 -4
- data/lib/stripe/params/setup_intent_confirm_params.rb +225 -3
- data/lib/stripe/params/setup_intent_create_params.rb +231 -3
- data/lib/stripe/params/setup_intent_list_params.rb +4 -0
- data/lib/stripe/params/setup_intent_update_params.rb +231 -3
- data/lib/stripe/params/subscription_attach_cadence_params.rb +16 -0
- data/lib/stripe/params/subscription_create_params.rb +259 -5
- data/lib/stripe/params/subscription_item_create_params.rb +46 -2
- data/lib/stripe/params/subscription_item_update_params.rb +29 -1
- data/lib/stripe/params/subscription_list_params.rb +4 -0
- data/lib/stripe/params/subscription_schedule_amend_params.rb +570 -0
- data/lib/stripe/params/subscription_schedule_create_params.rb +167 -5
- data/lib/stripe/params/subscription_schedule_list_params.rb +4 -0
- data/lib/stripe/params/subscription_schedule_update_params.rb +163 -5
- data/lib/stripe/params/subscription_update_params.rb +238 -4
- data/lib/stripe/params/tax/association_find_params.rb +18 -0
- data/lib/stripe/params/tax/form_list_params.rb +51 -0
- data/lib/stripe/params/tax/form_pdf_params.rb +15 -0
- data/lib/stripe/params/tax/form_retrieve_params.rb +15 -0
- data/lib/stripe/params/tax_id_create_params.rb +4 -1
- data/lib/stripe/params/tax_id_list_params.rb +4 -1
- data/lib/stripe/params/terminal/configuration_create_params.rb +13 -0
- data/lib/stripe/params/terminal/configuration_update_params.rb +13 -0
- data/lib/stripe/params/terminal/onboarding_link_create_params.rb +43 -0
- data/lib/stripe/params/terminal/reader_collected_data_retrieve_params.rb +15 -0
- data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +97 -0
- data/lib/stripe/params/test_helpers/treasury/received_credit_create_params.rb +25 -1
- data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +25 -1
- data/lib/stripe/params/transfer_create_params.rb +4 -0
- data/lib/stripe/params/treasury/financial_account_create_params.rb +8 -1
- data/lib/stripe/params/treasury/financial_account_features_update_params.rb +4 -1
- data/lib/stripe/params/treasury/financial_account_update_features_params.rb +4 -1
- data/lib/stripe/params/treasury/financial_account_update_params.rb +8 -1
- data/lib/stripe/params/treasury/outbound_transfer_create_params.rb +24 -0
- data/lib/stripe/params/treasury/received_credit_create_params.rb +25 -1
- data/lib/stripe/params/treasury/received_debit_create_params.rb +25 -1
- data/lib/stripe/params/v2/billing/bill_setting_create_params.rb +74 -0
- data/lib/stripe/params/v2/billing/bill_setting_list_params.rb +21 -0
- data/lib/stripe/params/v2/billing/bill_setting_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/bill_setting_update_params.rb +80 -0
- data/lib/stripe/params/v2/billing/bill_settings/version_list_params.rb +19 -0
- data/lib/stripe/params/v2/billing/bill_settings/version_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/billing/cadence_cancel_params.rb +10 -0
- data/lib/stripe/params/v2/billing/cadence_create_params.rb +253 -0
- data/lib/stripe/params/v2/billing/cadence_list_params.rb +43 -0
- data/lib/stripe/params/v2/billing/cadence_retrieve_params.rb +17 -0
- data/lib/stripe/params/v2/billing/cadence_update_params.rb +75 -0
- data/lib/stripe/params/v2/billing/collection_setting_create_params.rb +223 -0
- data/lib/stripe/params/v2/billing/collection_setting_list_params.rb +21 -0
- data/lib/stripe/params/v2/billing/collection_setting_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/collection_setting_update_params.rb +229 -0
- data/lib/stripe/params/v2/billing/collection_settings/version_list_params.rb +19 -0
- data/lib/stripe/params/v2/billing/collection_settings/version_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/billing/profile_create_params.rb +37 -0
- data/lib/stripe/params/v2/billing/profile_list_params.rb +40 -0
- data/lib/stripe/params/v2/billing/profile_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/billing/profile_update_params.rb +35 -0
- data/lib/stripe/params/v2/core/account_close_params.rb +17 -0
- data/lib/stripe/params/v2/core/account_create_params.rb +2217 -0
- data/lib/stripe/params/v2/core/account_link_create_params.rb +101 -0
- data/lib/stripe/params/v2/core/account_list_params.rb +20 -0
- data/lib/stripe/params/v2/core/account_retrieve_params.rb +17 -0
- data/lib/stripe/params/v2/core/account_update_params.rb +2245 -0
- data/lib/stripe/params/v2/core/accounts/person_create_params.rb +493 -0
- data/lib/stripe/params/v2/core/accounts/person_delete_params.rb +12 -0
- data/lib/stripe/params/v2/core/accounts/person_list_params.rb +19 -0
- data/lib/stripe/params/v2/core/accounts/person_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/core/accounts/person_update_params.rb +493 -0
- data/lib/stripe/params/v2/core/vault/gb_bank_account_acknowledge_confirmation_of_payee_params.rb +12 -0
- data/lib/stripe/params/v2/core/vault/gb_bank_account_archive_params.rb +12 -0
- data/lib/stripe/params/v2/core/vault/gb_bank_account_create_params.rb +50 -0
- data/lib/stripe/params/v2/core/vault/gb_bank_account_initiate_confirmation_of_payee_params.rb +22 -0
- data/lib/stripe/params/v2/core/vault/gb_bank_account_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/core/vault/us_bank_account_archive_params.rb +12 -0
- data/lib/stripe/params/v2/core/vault/us_bank_account_create_params.rb +33 -0
- data/lib/stripe/params/v2/core/vault/us_bank_account_retrieve_params.rb +12 -0
- data/lib/stripe/params/v2/core/vault/us_bank_account_update_params.rb +22 -0
- data/lib/stripe/params/v2/money_management/adjustment_list_params.rb +48 -0
- data/lib/stripe/params/v2/money_management/adjustment_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/financial_account_close_params.rb +28 -0
- data/lib/stripe/params/v2/money_management/financial_account_create_params.rb +34 -0
- data/lib/stripe/params/v2/money_management/financial_account_list_params.rb +20 -0
- data/lib/stripe/params/v2/money_management/financial_account_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/financial_address_create_params.rb +20 -0
- data/lib/stripe/params/v2/money_management/financial_address_list_params.rb +23 -0
- data/lib/stripe/params/v2/money_management/financial_address_retrieve_params.rb +17 -0
- data/lib/stripe/params/v2/money_management/inbound_transfer_create_params.rb +50 -0
- data/lib/stripe/params/v2/money_management/inbound_transfer_list_params.rb +44 -0
- data/lib/stripe/params/v2/money_management/inbound_transfer_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/outbound_payment_cancel_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/outbound_payment_create_params.rb +98 -0
- data/lib/stripe/params/v2/money_management/outbound_payment_list_params.rb +52 -0
- data/lib/stripe/params/v2/money_management/outbound_payment_quote_create_params.rb +67 -0
- data/lib/stripe/params/v2/money_management/outbound_payment_quote_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/outbound_payment_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/outbound_setup_intent_cancel_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/outbound_setup_intent_create_params.rb +85 -0
- data/lib/stripe/params/v2/money_management/outbound_setup_intent_list_params.rb +17 -0
- data/lib/stripe/params/v2/money_management/outbound_setup_intent_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/outbound_setup_intent_update_params.rb +80 -0
- data/lib/stripe/params/v2/money_management/outbound_transfer_cancel_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/outbound_transfer_create_params.rb +77 -0
- data/lib/stripe/params/v2/money_management/outbound_transfer_list_params.rb +48 -0
- data/lib/stripe/params/v2/money_management/outbound_transfer_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/payout_method_archive_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/payout_method_list_params.rb +31 -0
- data/lib/stripe/params/v2/money_management/payout_method_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/payout_method_unarchive_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/payout_methods_bank_account_spec_retrieve_params.rb +17 -0
- data/lib/stripe/params/v2/money_management/received_credit_list_params.rb +44 -0
- data/lib/stripe/params/v2/money_management/received_credit_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/received_debit_list_params.rb +17 -0
- data/lib/stripe/params/v2/money_management/received_debit_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/transaction_entry_list_params.rb +43 -0
- data/lib/stripe/params/v2/money_management/transaction_entry_retrieve_params.rb +10 -0
- data/lib/stripe/params/v2/money_management/transaction_list_params.rb +47 -0
- data/lib/stripe/params/v2/money_management/transaction_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 +61 -0
- data/lib/stripe/params/v2/payments/off_session_payment_create_params.rb +237 -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/test_helpers/financial_address_credit_params.rb +23 -0
- data/lib/stripe/params/v2/test_helpers/financial_address_generate_microdeposits_params.rb +10 -0
- data/lib/stripe/params.rb +169 -0
- data/lib/stripe/resources/account.rb +166 -1
- data/lib/stripe/resources/account_notice.rb +94 -0
- data/lib/stripe/resources/account_session.rb +81 -0
- data/lib/stripe/resources/billing/analytics/meter_usage.rb +33 -0
- data/lib/stripe/resources/billing/analytics/meter_usage_row.rb +38 -0
- data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
- data/lib/stripe/resources/billing/credit_grant.rb +2 -0
- data/lib/stripe/resources/billing_portal/session.rb +2 -0
- data/lib/stripe/resources/capital/financing_offer.rb +142 -0
- data/lib/stripe/resources/capital/financing_summary.rb +79 -0
- data/lib/stripe/resources/capital/financing_transaction.rb +99 -0
- data/lib/stripe/resources/card.rb +2 -0
- data/lib/stripe/resources/cash_balance.rb +2 -0
- data/lib/stripe/resources/charge.rb +234 -1
- data/lib/stripe/resources/checkout/session.rb +154 -4
- data/lib/stripe/resources/confirmation_token.rb +155 -0
- data/lib/stripe/resources/coupon.rb +26 -1
- data/lib/stripe/resources/credit_note.rb +2 -0
- data/lib/stripe/resources/credit_note_line_item.rb +18 -0
- data/lib/stripe/resources/customer.rb +2 -0
- data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
- data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
- data/lib/stripe/resources/customer_session.rb +2 -0
- data/lib/stripe/resources/discount.rb +2 -0
- data/lib/stripe/resources/dispute.rb +22 -0
- data/lib/stripe/resources/event.rb +64 -1
- data/lib/stripe/resources/financial_connections/account.rb +27 -0
- data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +35 -0
- data/lib/stripe/resources/financial_connections/institution.rb +127 -0
- data/lib/stripe/resources/financial_connections/session.rb +67 -1
- data/lib/stripe/resources/fx_quote.rb +147 -0
- data/lib/stripe/resources/identity/verification_session.rb +2 -0
- data/lib/stripe/resources/invoice.rb +152 -1
- data/lib/stripe/resources/invoice_item.rb +4 -0
- data/lib/stripe/resources/invoice_line_item.rb +40 -0
- data/lib/stripe/resources/invoice_payment.rb +2 -0
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +263 -0
- data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +71 -0
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +51 -0
- data/lib/stripe/resources/issuing/settlement.rb +61 -0
- data/lib/stripe/resources/issuing/transaction.rb +2 -0
- data/lib/stripe/resources/line_item.rb +68 -1
- data/lib/stripe/resources/mandate.rb +71 -0
- data/lib/stripe/resources/margin.rb +64 -0
- data/lib/stripe/resources/order.rb +987 -0
- data/lib/stripe/resources/payment_attempt_record.rb +2102 -0
- data/lib/stripe/resources/payment_intent.rb +848 -4
- data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +128 -0
- data/lib/stripe/resources/payment_method.rb +157 -0
- data/lib/stripe/resources/payment_method_configuration.rb +204 -0
- data/lib/stripe/resources/payment_record.rb +2208 -0
- data/lib/stripe/resources/price.rb +20 -0
- data/lib/stripe/resources/privacy/redaction_job.rb +187 -0
- data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +49 -0
- data/lib/stripe/resources/promotion_code.rb +2 -0
- data/lib/stripe/resources/quote.rb +571 -2
- data/lib/stripe/resources/quote_line.rb +521 -0
- data/lib/stripe/resources/quote_preview_invoice.rb +1150 -0
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +732 -0
- data/lib/stripe/resources/refund.rb +18 -0
- data/lib/stripe/resources/setup_attempt.rb +63 -0
- data/lib/stripe/resources/setup_intent.rb +132 -1
- data/lib/stripe/resources/source.rb +38 -0
- data/lib/stripe/resources/subscription.rb +232 -0
- data/lib/stripe/resources/subscription_item.rb +20 -1
- data/lib/stripe/resources/subscription_schedule.rb +198 -3
- data/lib/stripe/resources/tax/association.rb +86 -0
- data/lib/stripe/resources/tax/form.rb +264 -0
- data/lib/stripe/resources/tax_id.rb +4 -0
- data/lib/stripe/resources/terminal/configuration.rb +16 -0
- data/lib/stripe/resources/terminal/onboarding_link.rb +71 -0
- data/lib/stripe/resources/terminal/reader.rb +8 -0
- data/lib/stripe/resources/terminal/reader_collected_data.rb +47 -0
- data/lib/stripe/resources/transfer.rb +2 -0
- data/lib/stripe/resources/treasury/financial_account.rb +2 -0
- data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
- data/lib/stripe/resources/treasury/outbound_transfer.rb +30 -0
- data/lib/stripe/resources/treasury/received_credit.rb +30 -0
- data/lib/stripe/resources/treasury/received_debit.rb +32 -0
- data/lib/stripe/resources/v2/billing/bill_setting.rb +102 -0
- data/lib/stripe/resources/v2/billing/bill_setting_version.rb +90 -0
- data/lib/stripe/resources/v2/billing/cadence.rb +609 -0
- data/lib/stripe/resources/v2/billing/collection_setting.rb +274 -0
- data/lib/stripe/resources/v2/billing/collection_setting_version.rb +262 -0
- data/lib/stripe/resources/v2/billing/profile.rb +46 -0
- data/lib/stripe/resources/v2/core/account.rb +3851 -0
- data/lib/stripe/resources/v2/core/account_link.rb +123 -0
- data/lib/stripe/resources/v2/core/account_person.rb +477 -0
- data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +114 -0
- data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +47 -0
- data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +28 -0
- data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +30 -0
- data/lib/stripe/resources/v2/money_management/adjustment.rb +67 -0
- data/lib/stripe/resources/v2/money_management/financial_account.rb +140 -0
- data/lib/stripe/resources/v2/money_management/financial_address.rb +132 -0
- data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +148 -0
- data/lib/stripe/resources/v2/money_management/outbound_payment.rb +217 -0
- data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +144 -0
- data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +69 -0
- data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +196 -0
- data/lib/stripe/resources/v2/money_management/payout_method.rb +109 -0
- data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +81 -0
- data/lib/stripe/resources/v2/money_management/received_credit.rb +228 -0
- data/lib/stripe/resources/v2/money_management/received_debit.rb +136 -0
- data/lib/stripe/resources/v2/money_management/transaction.rb +116 -0
- data/lib/stripe/resources/v2/money_management/transaction_entry.rb +105 -0
- data/lib/stripe/resources/v2/payments/off_session_payment.rb +242 -0
- data/lib/stripe/resources.rb +116 -0
- data/lib/stripe/services/account_notice_service.rb +39 -0
- data/lib/stripe/services/billing/analytics/meter_usage_service.rb +21 -0
- data/lib/stripe/services/billing/analytics_service.rb +15 -0
- data/lib/stripe/services/billing_service.rb +2 -1
- data/lib/stripe/services/capital/financing_offer_service.rb +42 -0
- data/lib/stripe/services/capital/financing_summary_service.rb +19 -0
- data/lib/stripe/services/capital/financing_transaction_service.rb +31 -0
- data/lib/stripe/services/capital_service.rb +15 -0
- data/lib/stripe/services/external_account_service.rb +68 -0
- data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +19 -0
- data/lib/stripe/services/financial_connections/account_service.rb +3 -1
- data/lib/stripe/services/financial_connections/institution_service.rb +30 -0
- data/lib/stripe/services/financial_connections_service.rb +2 -1
- data/lib/stripe/services/fx_quote_service.rb +27 -0
- data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +74 -0
- data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +30 -0
- data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +30 -0
- data/lib/stripe/services/issuing_service.rb +5 -1
- data/lib/stripe/services/mandate_service.rb +5 -0
- data/lib/stripe/services/margin_service.rb +50 -0
- data/lib/stripe/services/order_line_item_service.rb +17 -0
- data/lib/stripe/services/order_service.rb +78 -0
- data/lib/stripe/services/payment_attempt_record_service.rb +28 -0
- data/lib/stripe/services/payment_intent_amount_details_line_item_service.rb +17 -0
- data/lib/stripe/services/payment_intent_service.rb +44 -0
- data/lib/stripe/services/payment_record_service.rb +89 -0
- data/lib/stripe/services/privacy/redaction_job_service.rb +104 -0
- data/lib/stripe/services/privacy/redaction_job_validation_error_service.rb +19 -0
- data/lib/stripe/services/privacy_service.rb +13 -0
- data/lib/stripe/services/quote_line_service.rb +17 -0
- data/lib/stripe/services/quote_preview_invoice_service.rb +17 -0
- data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +17 -0
- data/lib/stripe/services/quote_service.rb +49 -1
- data/lib/stripe/services/subscription_schedule_service.rb +11 -0
- data/lib/stripe/services/subscription_service.rb +11 -0
- data/lib/stripe/services/tax/association_service.rb +19 -0
- data/lib/stripe/services/tax/form_service.rb +37 -0
- data/lib/stripe/services/tax_service.rb +3 -1
- data/lib/stripe/services/terminal/onboarding_link_service.rb +19 -0
- data/lib/stripe/services/terminal/reader_collected_data_service.rb +19 -0
- data/lib/stripe/services/terminal_service.rb +3 -1
- data/lib/stripe/services/v1_services.rb +10 -1
- data/lib/stripe/services/v2/billing/bill_setting_service.rb +61 -0
- data/lib/stripe/services/v2/billing/bill_settings/version_service.rb +34 -0
- data/lib/stripe/services/v2/billing/cadence_service.rb +65 -0
- data/lib/stripe/services/v2/billing/collection_setting_service.rb +61 -0
- data/lib/stripe/services/v2/billing/collection_settings/version_service.rb +34 -0
- data/lib/stripe/services/v2/billing/profile_service.rb +54 -0
- data/lib/stripe/services/v2/billing_service.rb +5 -1
- data/lib/stripe/services/v2/core/account_link_service.rb +21 -0
- data/lib/stripe/services/v2/core/account_service.rb +76 -0
- data/lib/stripe/services/v2/core/accounts/person_service.rb +67 -0
- data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +74 -0
- data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +68 -0
- data/lib/stripe/services/v2/core/vault_service.rb +18 -0
- data/lib/stripe/services/v2/core_service.rb +4 -1
- data/lib/stripe/services/v2/money_management/adjustment_service.rb +32 -0
- data/lib/stripe/services/v2/money_management/financial_account_service.rb +59 -0
- data/lib/stripe/services/v2/money_management/financial_address_service.rb +46 -0
- data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +45 -0
- data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +34 -0
- data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +62 -0
- data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +73 -0
- data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +60 -0
- data/lib/stripe/services/v2/money_management/payout_method_service.rb +63 -0
- data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +23 -0
- data/lib/stripe/services/v2/money_management/received_credit_service.rb +32 -0
- data/lib/stripe/services/v2/money_management/received_debit_service.rb +32 -0
- data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +32 -0
- data/lib/stripe/services/v2/money_management/transaction_service.rb +32 -0
- data/lib/stripe/services/v2/money_management_service.rb +31 -0
- data/lib/stripe/services/v2/payment_service.rb +15 -0
- data/lib/stripe/services/v2/payments/off_session_payment_service.rb +65 -0
- data/lib/stripe/services/v2/test_helper_service.rb +15 -0
- data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +36 -0
- data/lib/stripe/services/v2_services.rb +4 -1
- data/lib/stripe/services.rb +61 -0
- data/lib/stripe/stripe_configuration.rb +3 -1
- data/lib/stripe/stripe_object.rb +1 -1
- data/lib/stripe/util.rb +7 -1
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe.rb +53 -0
- data/rbi/stripe.rbi +155102 -90522
- metadata +349 -3
@@ -145,16 +145,44 @@ module Stripe
|
|
145
145
|
class Phase < Stripe::RequestParams
|
146
146
|
class AddInvoiceItem < Stripe::RequestParams
|
147
147
|
class Discount < Stripe::RequestParams
|
148
|
+
class DiscountEnd < Stripe::RequestParams
|
149
|
+
class Duration < Stripe::RequestParams
|
150
|
+
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
151
|
+
attr_accessor :interval
|
152
|
+
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
153
|
+
attr_accessor :interval_count
|
154
|
+
|
155
|
+
def initialize(interval: nil, interval_count: nil)
|
156
|
+
@interval = interval
|
157
|
+
@interval_count = interval_count
|
158
|
+
end
|
159
|
+
end
|
160
|
+
# Time span for the redeemed discount.
|
161
|
+
attr_accessor :duration
|
162
|
+
# A precise Unix timestamp for the discount to end. Must be in the future.
|
163
|
+
attr_accessor :timestamp
|
164
|
+
# The type of calculation made to determine when the discount ends.
|
165
|
+
attr_accessor :type
|
166
|
+
|
167
|
+
def initialize(duration: nil, timestamp: nil, type: nil)
|
168
|
+
@duration = duration
|
169
|
+
@timestamp = timestamp
|
170
|
+
@type = type
|
171
|
+
end
|
172
|
+
end
|
148
173
|
# ID of the coupon to create a new discount for.
|
149
174
|
attr_accessor :coupon
|
150
175
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
151
176
|
attr_accessor :discount
|
177
|
+
# Details to determine how long the discount should be applied for.
|
178
|
+
attr_accessor :discount_end
|
152
179
|
# ID of the promotion code to create a new discount for.
|
153
180
|
attr_accessor :promotion_code
|
154
181
|
|
155
|
-
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
182
|
+
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
|
156
183
|
@coupon = coupon
|
157
184
|
@discount = discount
|
185
|
+
@discount_end = discount_end
|
158
186
|
@promotion_code = promotion_code
|
159
187
|
end
|
160
188
|
end
|
@@ -290,16 +318,44 @@ module Stripe
|
|
290
318
|
end
|
291
319
|
|
292
320
|
class Discount < Stripe::RequestParams
|
321
|
+
class DiscountEnd < Stripe::RequestParams
|
322
|
+
class Duration < Stripe::RequestParams
|
323
|
+
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
324
|
+
attr_accessor :interval
|
325
|
+
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
326
|
+
attr_accessor :interval_count
|
327
|
+
|
328
|
+
def initialize(interval: nil, interval_count: nil)
|
329
|
+
@interval = interval
|
330
|
+
@interval_count = interval_count
|
331
|
+
end
|
332
|
+
end
|
333
|
+
# Time span for the redeemed discount.
|
334
|
+
attr_accessor :duration
|
335
|
+
# A precise Unix timestamp for the discount to end. Must be in the future.
|
336
|
+
attr_accessor :timestamp
|
337
|
+
# The type of calculation made to determine when the discount ends.
|
338
|
+
attr_accessor :type
|
339
|
+
|
340
|
+
def initialize(duration: nil, timestamp: nil, type: nil)
|
341
|
+
@duration = duration
|
342
|
+
@timestamp = timestamp
|
343
|
+
@type = type
|
344
|
+
end
|
345
|
+
end
|
293
346
|
# ID of the coupon to create a new discount for.
|
294
347
|
attr_accessor :coupon
|
295
348
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
296
349
|
attr_accessor :discount
|
350
|
+
# Details to determine how long the discount should be applied for.
|
351
|
+
attr_accessor :discount_end
|
297
352
|
# ID of the promotion code to create a new discount for.
|
298
353
|
attr_accessor :promotion_code
|
299
354
|
|
300
|
-
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
355
|
+
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
|
301
356
|
@coupon = coupon
|
302
357
|
@discount = discount
|
358
|
+
@discount_end = discount_end
|
303
359
|
@promotion_code = promotion_code
|
304
360
|
end
|
305
361
|
end
|
@@ -353,16 +409,44 @@ module Stripe
|
|
353
409
|
end
|
354
410
|
|
355
411
|
class Discount < Stripe::RequestParams
|
412
|
+
class DiscountEnd < Stripe::RequestParams
|
413
|
+
class Duration < Stripe::RequestParams
|
414
|
+
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
415
|
+
attr_accessor :interval
|
416
|
+
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
417
|
+
attr_accessor :interval_count
|
418
|
+
|
419
|
+
def initialize(interval: nil, interval_count: nil)
|
420
|
+
@interval = interval
|
421
|
+
@interval_count = interval_count
|
422
|
+
end
|
423
|
+
end
|
424
|
+
# Time span for the redeemed discount.
|
425
|
+
attr_accessor :duration
|
426
|
+
# A precise Unix timestamp for the discount to end. Must be in the future.
|
427
|
+
attr_accessor :timestamp
|
428
|
+
# The type of calculation made to determine when the discount ends.
|
429
|
+
attr_accessor :type
|
430
|
+
|
431
|
+
def initialize(duration: nil, timestamp: nil, type: nil)
|
432
|
+
@duration = duration
|
433
|
+
@timestamp = timestamp
|
434
|
+
@type = type
|
435
|
+
end
|
436
|
+
end
|
356
437
|
# ID of the coupon to create a new discount for.
|
357
438
|
attr_accessor :coupon
|
358
439
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
359
440
|
attr_accessor :discount
|
441
|
+
# Details to determine how long the discount should be applied for.
|
442
|
+
attr_accessor :discount_end
|
360
443
|
# ID of the promotion code to create a new discount for.
|
361
444
|
attr_accessor :promotion_code
|
362
445
|
|
363
|
-
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
446
|
+
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
|
364
447
|
@coupon = coupon
|
365
448
|
@discount = discount
|
449
|
+
@discount_end = discount_end
|
366
450
|
@promotion_code = promotion_code
|
367
451
|
end
|
368
452
|
end
|
@@ -408,6 +492,18 @@ module Stripe
|
|
408
492
|
@unit_amount_decimal = unit_amount_decimal
|
409
493
|
end
|
410
494
|
end
|
495
|
+
|
496
|
+
class Trial < Stripe::RequestParams
|
497
|
+
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
|
498
|
+
attr_accessor :converts_to
|
499
|
+
# Determines the type of trial for this item.
|
500
|
+
attr_accessor :type
|
501
|
+
|
502
|
+
def initialize(converts_to: nil, type: nil)
|
503
|
+
@converts_to = converts_to
|
504
|
+
@type = type
|
505
|
+
end
|
506
|
+
end
|
411
507
|
# 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.
|
412
508
|
attr_accessor :billing_thresholds
|
413
509
|
# The coupons to redeem into discounts for the subscription item.
|
@@ -424,6 +520,8 @@ module Stripe
|
|
424
520
|
attr_accessor :quantity
|
425
521
|
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
426
522
|
attr_accessor :tax_rates
|
523
|
+
# Options that configure the trial on the subscription item.
|
524
|
+
attr_accessor :trial
|
427
525
|
|
428
526
|
def initialize(
|
429
527
|
billing_thresholds: nil,
|
@@ -433,7 +531,8 @@ module Stripe
|
|
433
531
|
price: nil,
|
434
532
|
price_data: nil,
|
435
533
|
quantity: nil,
|
436
|
-
tax_rates: nil
|
534
|
+
tax_rates: nil,
|
535
|
+
trial: nil
|
437
536
|
)
|
438
537
|
@billing_thresholds = billing_thresholds
|
439
538
|
@discounts = discounts
|
@@ -443,6 +542,16 @@ module Stripe
|
|
443
542
|
@price_data = price_data
|
444
543
|
@quantity = quantity
|
445
544
|
@tax_rates = tax_rates
|
545
|
+
@trial = trial
|
546
|
+
end
|
547
|
+
end
|
548
|
+
|
549
|
+
class PauseCollection < Stripe::RequestParams
|
550
|
+
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
551
|
+
attr_accessor :behavior
|
552
|
+
|
553
|
+
def initialize(behavior: nil)
|
554
|
+
@behavior = behavior
|
446
555
|
end
|
447
556
|
end
|
448
557
|
|
@@ -457,6 +566,23 @@ module Stripe
|
|
457
566
|
@destination = destination
|
458
567
|
end
|
459
568
|
end
|
569
|
+
|
570
|
+
class TrialSettings < Stripe::RequestParams
|
571
|
+
class EndBehavior < Stripe::RequestParams
|
572
|
+
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
573
|
+
attr_accessor :prorate_up_front
|
574
|
+
|
575
|
+
def initialize(prorate_up_front: nil)
|
576
|
+
@prorate_up_front = prorate_up_front
|
577
|
+
end
|
578
|
+
end
|
579
|
+
# Defines how the subscription should behave when a trial ends.
|
580
|
+
attr_accessor :end_behavior
|
581
|
+
|
582
|
+
def initialize(end_behavior: nil)
|
583
|
+
@end_behavior = end_behavior
|
584
|
+
end
|
585
|
+
end
|
460
586
|
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
|
461
587
|
attr_accessor :add_invoice_items
|
462
588
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
|
@@ -491,14 +617,20 @@ module Stripe
|
|
491
617
|
attr_accessor :metadata
|
492
618
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
493
619
|
attr_accessor :on_behalf_of
|
620
|
+
# 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/docs/billing/subscriptions/pause-payment).
|
621
|
+
attr_accessor :pause_collection
|
494
622
|
# Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/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://stripe.com/docs/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.
|
495
623
|
attr_accessor :proration_behavior
|
496
624
|
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
497
625
|
attr_accessor :transfer_data
|
498
626
|
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
499
627
|
attr_accessor :trial
|
628
|
+
# Specify trial behavior when crossing phase boundaries
|
629
|
+
attr_accessor :trial_continuation
|
500
630
|
# Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
|
501
631
|
attr_accessor :trial_end
|
632
|
+
# Settings related to subscription trials.
|
633
|
+
attr_accessor :trial_settings
|
502
634
|
|
503
635
|
def initialize(
|
504
636
|
add_invoice_items: nil,
|
@@ -518,10 +650,13 @@ module Stripe
|
|
518
650
|
items: nil,
|
519
651
|
metadata: nil,
|
520
652
|
on_behalf_of: nil,
|
653
|
+
pause_collection: nil,
|
521
654
|
proration_behavior: nil,
|
522
655
|
transfer_data: nil,
|
523
656
|
trial: nil,
|
524
|
-
|
657
|
+
trial_continuation: nil,
|
658
|
+
trial_end: nil,
|
659
|
+
trial_settings: nil
|
525
660
|
)
|
526
661
|
@add_invoice_items = add_invoice_items
|
527
662
|
@application_fee_percent = application_fee_percent
|
@@ -540,16 +675,35 @@ module Stripe
|
|
540
675
|
@items = items
|
541
676
|
@metadata = metadata
|
542
677
|
@on_behalf_of = on_behalf_of
|
678
|
+
@pause_collection = pause_collection
|
543
679
|
@proration_behavior = proration_behavior
|
544
680
|
@transfer_data = transfer_data
|
545
681
|
@trial = trial
|
682
|
+
@trial_continuation = trial_continuation
|
546
683
|
@trial_end = trial_end
|
684
|
+
@trial_settings = trial_settings
|
685
|
+
end
|
686
|
+
end
|
687
|
+
|
688
|
+
class Prebilling < Stripe::RequestParams
|
689
|
+
# This is used to determine the number of billing cycles to prebill.
|
690
|
+
attr_accessor :iterations
|
691
|
+
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
692
|
+
attr_accessor :update_behavior
|
693
|
+
|
694
|
+
def initialize(iterations: nil, update_behavior: nil)
|
695
|
+
@iterations = iterations
|
696
|
+
@update_behavior = update_behavior
|
547
697
|
end
|
548
698
|
end
|
699
|
+
# 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.
|
700
|
+
attr_accessor :billing_behavior
|
549
701
|
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
550
702
|
attr_accessor :billing_mode
|
551
703
|
# The identifier of the customer to create the subscription schedule for.
|
552
704
|
attr_accessor :customer
|
705
|
+
# The identifier of the account to create the subscription schedule for.
|
706
|
+
attr_accessor :customer_account
|
553
707
|
# Object representing the subscription schedule's default settings.
|
554
708
|
attr_accessor :default_settings
|
555
709
|
# 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.
|
@@ -562,28 +716,36 @@ module Stripe
|
|
562
716
|
attr_accessor :metadata
|
563
717
|
# 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.
|
564
718
|
attr_accessor :phases
|
719
|
+
# If specified, the invoicing for the given billing cycle iterations will be processed now.
|
720
|
+
attr_accessor :prebilling
|
565
721
|
# When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
|
566
722
|
attr_accessor :start_date
|
567
723
|
|
568
724
|
def initialize(
|
725
|
+
billing_behavior: nil,
|
569
726
|
billing_mode: nil,
|
570
727
|
customer: nil,
|
728
|
+
customer_account: nil,
|
571
729
|
default_settings: nil,
|
572
730
|
end_behavior: nil,
|
573
731
|
expand: nil,
|
574
732
|
from_subscription: nil,
|
575
733
|
metadata: nil,
|
576
734
|
phases: nil,
|
735
|
+
prebilling: nil,
|
577
736
|
start_date: nil
|
578
737
|
)
|
738
|
+
@billing_behavior = billing_behavior
|
579
739
|
@billing_mode = billing_mode
|
580
740
|
@customer = customer
|
741
|
+
@customer_account = customer_account
|
581
742
|
@default_settings = default_settings
|
582
743
|
@end_behavior = end_behavior
|
583
744
|
@expand = expand
|
584
745
|
@from_subscription = from_subscription
|
585
746
|
@metadata = metadata
|
586
747
|
@phases = phases
|
748
|
+
@prebilling = prebilling
|
587
749
|
@start_date = start_date
|
588
750
|
end
|
589
751
|
end
|
@@ -82,6 +82,8 @@ module Stripe
|
|
82
82
|
attr_accessor :created
|
83
83
|
# Only return subscription schedules for the given customer.
|
84
84
|
attr_accessor :customer
|
85
|
+
# Only return subscription schedules for the given account.
|
86
|
+
attr_accessor :customer_account
|
85
87
|
# 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.
|
86
88
|
attr_accessor :ending_before
|
87
89
|
# Specifies which fields in the response should be expanded.
|
@@ -100,6 +102,7 @@ module Stripe
|
|
100
102
|
completed_at: nil,
|
101
103
|
created: nil,
|
102
104
|
customer: nil,
|
105
|
+
customer_account: nil,
|
103
106
|
ending_before: nil,
|
104
107
|
expand: nil,
|
105
108
|
limit: nil,
|
@@ -111,6 +114,7 @@ module Stripe
|
|
111
114
|
@completed_at = completed_at
|
112
115
|
@created = created
|
113
116
|
@customer = customer
|
117
|
+
@customer_account = customer_account
|
114
118
|
@ending_before = ending_before
|
115
119
|
@expand = expand
|
116
120
|
@limit = limit
|
@@ -125,16 +125,44 @@ module Stripe
|
|
125
125
|
class Phase < Stripe::RequestParams
|
126
126
|
class AddInvoiceItem < Stripe::RequestParams
|
127
127
|
class Discount < Stripe::RequestParams
|
128
|
+
class DiscountEnd < Stripe::RequestParams
|
129
|
+
class Duration < Stripe::RequestParams
|
130
|
+
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
131
|
+
attr_accessor :interval
|
132
|
+
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
133
|
+
attr_accessor :interval_count
|
134
|
+
|
135
|
+
def initialize(interval: nil, interval_count: nil)
|
136
|
+
@interval = interval
|
137
|
+
@interval_count = interval_count
|
138
|
+
end
|
139
|
+
end
|
140
|
+
# Time span for the redeemed discount.
|
141
|
+
attr_accessor :duration
|
142
|
+
# A precise Unix timestamp for the discount to end. Must be in the future.
|
143
|
+
attr_accessor :timestamp
|
144
|
+
# The type of calculation made to determine when the discount ends.
|
145
|
+
attr_accessor :type
|
146
|
+
|
147
|
+
def initialize(duration: nil, timestamp: nil, type: nil)
|
148
|
+
@duration = duration
|
149
|
+
@timestamp = timestamp
|
150
|
+
@type = type
|
151
|
+
end
|
152
|
+
end
|
128
153
|
# ID of the coupon to create a new discount for.
|
129
154
|
attr_accessor :coupon
|
130
155
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
131
156
|
attr_accessor :discount
|
157
|
+
# Details to determine how long the discount should be applied for.
|
158
|
+
attr_accessor :discount_end
|
132
159
|
# ID of the promotion code to create a new discount for.
|
133
160
|
attr_accessor :promotion_code
|
134
161
|
|
135
|
-
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
162
|
+
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
|
136
163
|
@coupon = coupon
|
137
164
|
@discount = discount
|
165
|
+
@discount_end = discount_end
|
138
166
|
@promotion_code = promotion_code
|
139
167
|
end
|
140
168
|
end
|
@@ -270,16 +298,44 @@ module Stripe
|
|
270
298
|
end
|
271
299
|
|
272
300
|
class Discount < Stripe::RequestParams
|
301
|
+
class DiscountEnd < Stripe::RequestParams
|
302
|
+
class Duration < Stripe::RequestParams
|
303
|
+
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
304
|
+
attr_accessor :interval
|
305
|
+
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
306
|
+
attr_accessor :interval_count
|
307
|
+
|
308
|
+
def initialize(interval: nil, interval_count: nil)
|
309
|
+
@interval = interval
|
310
|
+
@interval_count = interval_count
|
311
|
+
end
|
312
|
+
end
|
313
|
+
# Time span for the redeemed discount.
|
314
|
+
attr_accessor :duration
|
315
|
+
# A precise Unix timestamp for the discount to end. Must be in the future.
|
316
|
+
attr_accessor :timestamp
|
317
|
+
# The type of calculation made to determine when the discount ends.
|
318
|
+
attr_accessor :type
|
319
|
+
|
320
|
+
def initialize(duration: nil, timestamp: nil, type: nil)
|
321
|
+
@duration = duration
|
322
|
+
@timestamp = timestamp
|
323
|
+
@type = type
|
324
|
+
end
|
325
|
+
end
|
273
326
|
# ID of the coupon to create a new discount for.
|
274
327
|
attr_accessor :coupon
|
275
328
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
276
329
|
attr_accessor :discount
|
330
|
+
# Details to determine how long the discount should be applied for.
|
331
|
+
attr_accessor :discount_end
|
277
332
|
# ID of the promotion code to create a new discount for.
|
278
333
|
attr_accessor :promotion_code
|
279
334
|
|
280
|
-
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
335
|
+
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
|
281
336
|
@coupon = coupon
|
282
337
|
@discount = discount
|
338
|
+
@discount_end = discount_end
|
283
339
|
@promotion_code = promotion_code
|
284
340
|
end
|
285
341
|
end
|
@@ -333,16 +389,44 @@ module Stripe
|
|
333
389
|
end
|
334
390
|
|
335
391
|
class Discount < Stripe::RequestParams
|
392
|
+
class DiscountEnd < Stripe::RequestParams
|
393
|
+
class Duration < Stripe::RequestParams
|
394
|
+
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
395
|
+
attr_accessor :interval
|
396
|
+
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
397
|
+
attr_accessor :interval_count
|
398
|
+
|
399
|
+
def initialize(interval: nil, interval_count: nil)
|
400
|
+
@interval = interval
|
401
|
+
@interval_count = interval_count
|
402
|
+
end
|
403
|
+
end
|
404
|
+
# Time span for the redeemed discount.
|
405
|
+
attr_accessor :duration
|
406
|
+
# A precise Unix timestamp for the discount to end. Must be in the future.
|
407
|
+
attr_accessor :timestamp
|
408
|
+
# The type of calculation made to determine when the discount ends.
|
409
|
+
attr_accessor :type
|
410
|
+
|
411
|
+
def initialize(duration: nil, timestamp: nil, type: nil)
|
412
|
+
@duration = duration
|
413
|
+
@timestamp = timestamp
|
414
|
+
@type = type
|
415
|
+
end
|
416
|
+
end
|
336
417
|
# ID of the coupon to create a new discount for.
|
337
418
|
attr_accessor :coupon
|
338
419
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
339
420
|
attr_accessor :discount
|
421
|
+
# Details to determine how long the discount should be applied for.
|
422
|
+
attr_accessor :discount_end
|
340
423
|
# ID of the promotion code to create a new discount for.
|
341
424
|
attr_accessor :promotion_code
|
342
425
|
|
343
|
-
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
426
|
+
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
|
344
427
|
@coupon = coupon
|
345
428
|
@discount = discount
|
429
|
+
@discount_end = discount_end
|
346
430
|
@promotion_code = promotion_code
|
347
431
|
end
|
348
432
|
end
|
@@ -388,6 +472,18 @@ module Stripe
|
|
388
472
|
@unit_amount_decimal = unit_amount_decimal
|
389
473
|
end
|
390
474
|
end
|
475
|
+
|
476
|
+
class Trial < Stripe::RequestParams
|
477
|
+
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
|
478
|
+
attr_accessor :converts_to
|
479
|
+
# Determines the type of trial for this item.
|
480
|
+
attr_accessor :type
|
481
|
+
|
482
|
+
def initialize(converts_to: nil, type: nil)
|
483
|
+
@converts_to = converts_to
|
484
|
+
@type = type
|
485
|
+
end
|
486
|
+
end
|
391
487
|
# 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.
|
392
488
|
attr_accessor :billing_thresholds
|
393
489
|
# The coupons to redeem into discounts for the subscription item.
|
@@ -404,6 +500,8 @@ module Stripe
|
|
404
500
|
attr_accessor :quantity
|
405
501
|
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
406
502
|
attr_accessor :tax_rates
|
503
|
+
# Options that configure the trial on the subscription item.
|
504
|
+
attr_accessor :trial
|
407
505
|
|
408
506
|
def initialize(
|
409
507
|
billing_thresholds: nil,
|
@@ -413,7 +511,8 @@ module Stripe
|
|
413
511
|
price: nil,
|
414
512
|
price_data: nil,
|
415
513
|
quantity: nil,
|
416
|
-
tax_rates: nil
|
514
|
+
tax_rates: nil,
|
515
|
+
trial: nil
|
417
516
|
)
|
418
517
|
@billing_thresholds = billing_thresholds
|
419
518
|
@discounts = discounts
|
@@ -423,6 +522,16 @@ module Stripe
|
|
423
522
|
@price_data = price_data
|
424
523
|
@quantity = quantity
|
425
524
|
@tax_rates = tax_rates
|
525
|
+
@trial = trial
|
526
|
+
end
|
527
|
+
end
|
528
|
+
|
529
|
+
class PauseCollection < Stripe::RequestParams
|
530
|
+
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
531
|
+
attr_accessor :behavior
|
532
|
+
|
533
|
+
def initialize(behavior: nil)
|
534
|
+
@behavior = behavior
|
426
535
|
end
|
427
536
|
end
|
428
537
|
|
@@ -437,6 +546,23 @@ module Stripe
|
|
437
546
|
@destination = destination
|
438
547
|
end
|
439
548
|
end
|
549
|
+
|
550
|
+
class TrialSettings < Stripe::RequestParams
|
551
|
+
class EndBehavior < Stripe::RequestParams
|
552
|
+
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
553
|
+
attr_accessor :prorate_up_front
|
554
|
+
|
555
|
+
def initialize(prorate_up_front: nil)
|
556
|
+
@prorate_up_front = prorate_up_front
|
557
|
+
end
|
558
|
+
end
|
559
|
+
# Defines how the subscription should behave when a trial ends.
|
560
|
+
attr_accessor :end_behavior
|
561
|
+
|
562
|
+
def initialize(end_behavior: nil)
|
563
|
+
@end_behavior = end_behavior
|
564
|
+
end
|
565
|
+
end
|
440
566
|
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
|
441
567
|
attr_accessor :add_invoice_items
|
442
568
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
|
@@ -471,6 +597,8 @@ module Stripe
|
|
471
597
|
attr_accessor :metadata
|
472
598
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
473
599
|
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/docs/billing/subscriptions/pause-payment).
|
601
|
+
attr_accessor :pause_collection
|
474
602
|
# Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/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://stripe.com/docs/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.
|
475
603
|
attr_accessor :proration_behavior
|
476
604
|
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
|
@@ -479,8 +607,12 @@ module Stripe
|
|
479
607
|
attr_accessor :transfer_data
|
480
608
|
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
481
609
|
attr_accessor :trial
|
610
|
+
# Specify trial behavior when crossing phase boundaries
|
611
|
+
attr_accessor :trial_continuation
|
482
612
|
# Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
|
483
613
|
attr_accessor :trial_end
|
614
|
+
# Settings related to subscription trials.
|
615
|
+
attr_accessor :trial_settings
|
484
616
|
|
485
617
|
def initialize(
|
486
618
|
add_invoice_items: nil,
|
@@ -500,11 +632,14 @@ module Stripe
|
|
500
632
|
items: nil,
|
501
633
|
metadata: nil,
|
502
634
|
on_behalf_of: nil,
|
635
|
+
pause_collection: nil,
|
503
636
|
proration_behavior: nil,
|
504
637
|
start_date: nil,
|
505
638
|
transfer_data: nil,
|
506
639
|
trial: nil,
|
507
|
-
|
640
|
+
trial_continuation: nil,
|
641
|
+
trial_end: nil,
|
642
|
+
trial_settings: nil
|
508
643
|
)
|
509
644
|
@add_invoice_items = add_invoice_items
|
510
645
|
@application_fee_percent = application_fee_percent
|
@@ -523,13 +658,30 @@ module Stripe
|
|
523
658
|
@items = items
|
524
659
|
@metadata = metadata
|
525
660
|
@on_behalf_of = on_behalf_of
|
661
|
+
@pause_collection = pause_collection
|
526
662
|
@proration_behavior = proration_behavior
|
527
663
|
@start_date = start_date
|
528
664
|
@transfer_data = transfer_data
|
529
665
|
@trial = trial
|
666
|
+
@trial_continuation = trial_continuation
|
530
667
|
@trial_end = trial_end
|
668
|
+
@trial_settings = trial_settings
|
669
|
+
end
|
670
|
+
end
|
671
|
+
|
672
|
+
class Prebilling < Stripe::RequestParams
|
673
|
+
# This is used to determine the number of billing cycles to prebill.
|
674
|
+
attr_accessor :iterations
|
675
|
+
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
676
|
+
attr_accessor :update_behavior
|
677
|
+
|
678
|
+
def initialize(iterations: nil, update_behavior: nil)
|
679
|
+
@iterations = iterations
|
680
|
+
@update_behavior = update_behavior
|
531
681
|
end
|
532
682
|
end
|
683
|
+
# 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
|
+
attr_accessor :billing_behavior
|
533
685
|
# Object representing the subscription schedule's default settings.
|
534
686
|
attr_accessor :default_settings
|
535
687
|
# 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.
|
@@ -540,22 +692,28 @@ module Stripe
|
|
540
692
|
attr_accessor :metadata
|
541
693
|
# 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.
|
542
694
|
attr_accessor :phases
|
695
|
+
# If specified, the invoicing for the given billing cycle iterations will be processed now.
|
696
|
+
attr_accessor :prebilling
|
543
697
|
# If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`.
|
544
698
|
attr_accessor :proration_behavior
|
545
699
|
|
546
700
|
def initialize(
|
701
|
+
billing_behavior: nil,
|
547
702
|
default_settings: nil,
|
548
703
|
end_behavior: nil,
|
549
704
|
expand: nil,
|
550
705
|
metadata: nil,
|
551
706
|
phases: nil,
|
707
|
+
prebilling: nil,
|
552
708
|
proration_behavior: nil
|
553
709
|
)
|
710
|
+
@billing_behavior = billing_behavior
|
554
711
|
@default_settings = default_settings
|
555
712
|
@end_behavior = end_behavior
|
556
713
|
@expand = expand
|
557
714
|
@metadata = metadata
|
558
715
|
@phases = phases
|
716
|
+
@prebilling = prebilling
|
559
717
|
@proration_behavior = proration_behavior
|
560
718
|
end
|
561
719
|
end
|