stripe 18.1.0.pre.beta.1 → 18.1.0
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 +0 -34
- data/lib/stripe/api_version.rb +2 -1
- data/lib/stripe/errors.rb +0 -63
- data/lib/stripe/event_types.rb +0 -209
- data/lib/stripe/object_types.rb +0 -49
- data/lib/stripe/params/account_create_params.rb +48 -329
- 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_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 +1 -226
- data/lib/stripe/params/account_update_params.rb +47 -291
- 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/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 +2 -1650
- 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 +3 -1651
- data/lib/stripe/params/checkout/session_create_params.rb +41 -167
- data/lib/stripe/params/checkout/session_update_params.rb +12 -152
- 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 -83
- data/lib/stripe/params/coupon_create_params.rb +2 -18
- 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_session_create_params.rb +1 -32
- data/lib/stripe/params/customer_update_params.rb +7 -7
- data/lib/stripe/params/dispute_update_params.rb +4 -13
- 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 +4 -33
- 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 +9 -41
- data/lib/stripe/params/invoice_attach_payment_params.rb +1 -43
- data/lib/stripe/params/invoice_create_params.rb +29 -110
- data/lib/stripe/params/invoice_create_preview_params.rb +42 -855
- data/lib/stripe/params/invoice_finalize_invoice_params.rb +1 -1
- data/lib/stripe/params/invoice_item_create_params.rb +9 -41
- data/lib/stripe/params/invoice_item_list_params.rb +2 -2
- data/lib/stripe/params/invoice_item_update_params.rb +7 -39
- data/lib/stripe/params/invoice_line_item_update_params.rb +8 -40
- 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 +9 -41
- data/lib/stripe/params/invoice_update_params.rb +26 -107
- 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_update_params.rb +6 -6
- data/lib/stripe/params/issuing/cardholder_create_params.rb +11 -12
- data/lib/stripe/params/issuing/cardholder_update_params.rb +10 -10
- 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/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_list_params.rb +0 -4
- 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/payment_intent_apply_customer_balance_params.rb +1 -1
- data/lib/stripe/params/payment_intent_capture_params.rb +13 -1639
- data/lib/stripe/params/payment_intent_confirm_params.rb +52 -3012
- data/lib/stripe/params/payment_intent_create_params.rb +68 -3028
- data/lib/stripe/params/payment_intent_increment_authorization_params.rb +11 -32
- 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 +57 -3048
- data/lib/stripe/params/payment_link_create_params.rb +19 -19
- 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 +38 -143
- data/lib/stripe/params/payment_method_configuration_update_params.rb +38 -143
- data/lib/stripe/params/payment_method_create_params.rb +4 -81
- 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 -22
- data/lib/stripe/params/product_create_params.rb +7 -7
- 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 +4 -4
- 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 +7 -805
- data/lib/stripe/params/quote_list_params.rb +2 -6
- data/lib/stripe/params/quote_update_params.rb +8 -813
- 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 +9 -164
- data/lib/stripe/params/setup_intent_create_params.rb +15 -170
- data/lib/stripe/params/setup_intent_update_params.rb +11 -166
- 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 +39 -264
- data/lib/stripe/params/subscription_item_create_params.rb +12 -56
- data/lib/stripe/params/subscription_item_delete_params.rb +2 -2
- data/lib/stripe/params/subscription_item_update_params.rb +11 -39
- 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_create_params.rb +20 -178
- data/lib/stripe/params/subscription_schedule_update_params.rb +20 -178
- data/lib/stripe/params/subscription_search_params.rb +1 -1
- data/lib/stripe/params/subscription_update_params.rb +36 -245
- 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/configuration_create_params.rb +0 -13
- data/lib/stripe/params/terminal/configuration_update_params.rb +0 -13
- 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 -83
- 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/treasury/received_credit_create_params.rb +2 -26
- data/lib/stripe/params/test_helpers/treasury/received_debit_create_params.rb +2 -26
- 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 -7
- 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 +2 -9
- data/lib/stripe/params/treasury/financial_account_features_update_params.rb +1 -4
- data/lib/stripe/params/treasury/financial_account_update_features_params.rb +1 -4
- data/lib/stripe/params/treasury/financial_account_update_params.rb +2 -9
- 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 -27
- data/lib/stripe/params/treasury/received_credit_create_params.rb +2 -26
- data/lib/stripe/params/treasury/received_debit_create_params.rb +2 -26
- data/lib/stripe/params/v2/core/account_create_params.rb +46 -271
- data/lib/stripe/params/v2/core/account_link_create_params.rb +5 -5
- data/lib/stripe/params/v2/core/account_token_create_params.rb +31 -21
- data/lib/stripe/params/v2/core/account_update_params.rb +50 -268
- 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/webhook_endpoint_create_params.rb +1 -1
- data/lib/stripe/params/webhook_endpoint_update_params.rb +1 -1
- data/lib/stripe/params.rb +0 -146
- data/lib/stripe/resources/account.rb +27 -208
- data/lib/stripe/resources/account_link.rb +1 -1
- data/lib/stripe/resources/account_session.rb +2 -83
- 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/bank_account.rb +10 -10
- data/lib/stripe/resources/billing/alert.rb +1 -1
- data/lib/stripe/resources/billing/credit_grant.rb +2 -2
- 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/card.rb +2 -4
- data/lib/stripe/resources/cash_balance.rb +2 -2
- data/lib/stripe/resources/charge.rb +46 -248
- data/lib/stripe/resources/checkout/session.rb +23 -123
- data/lib/stripe/resources/climate/order.rb +1 -1
- data/lib/stripe/resources/confirmation_token.rb +11 -144
- data/lib/stripe/resources/coupon.rb +4 -29
- data/lib/stripe/resources/credit_note.rb +5 -5
- data/lib/stripe/resources/credit_note_line_item.rb +1 -19
- 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/customer_session.rb +0 -36
- data/lib/stripe/resources/discount.rb +3 -3
- data/lib/stripe/resources/dispute.rb +5 -27
- data/lib/stripe/resources/entitlements/active_entitlement.rb +1 -1
- data/lib/stripe/resources/event.rb +2 -65
- 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 -28
- data/lib/stripe/resources/financial_connections/session.rb +3 -67
- data/lib/stripe/resources/forwarding/request.rb +1 -1
- data/lib/stripe/resources/funding_instructions.rb +14 -14
- 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 +49 -166
- data/lib/stripe/resources/invoice_item.rb +6 -8
- data/lib/stripe/resources/invoice_line_item.rb +6 -44
- 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 +12 -12
- data/lib/stripe/resources/issuing/cardholder.rb +14 -14
- data/lib/stripe/resources/issuing/dispute.rb +7 -7
- data/lib/stripe/resources/issuing/personalization_design.rb +1 -1
- data/lib/stripe/resources/issuing/token.rb +1 -1
- data/lib/stripe/resources/issuing/transaction.rb +12 -14
- data/lib/stripe/resources/line_item.rb +4 -69
- data/lib/stripe/resources/login_link.rb +1 -1
- data/lib/stripe/resources/mandate.rb +0 -43
- data/lib/stripe/resources/payment_attempt_record.rb +79 -201
- data/lib/stripe/resources/payment_intent.rb +59 -751
- 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 -148
- data/lib/stripe/resources/payment_method_configuration.rb +4 -174
- data/lib/stripe/resources/payment_method_domain.rb +1 -1
- data/lib/stripe/resources/payment_record.rb +81 -201
- 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 -26
- data/lib/stripe/resources/product.rb +9 -9
- data/lib/stripe/resources/promotion_code.rb +4 -4
- data/lib/stripe/resources/quote.rb +14 -581
- 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 -21
- 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 -65
- data/lib/stripe/resources/setup_intent.rb +20 -107
- 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 -46
- data/lib/stripe/resources/source_mandate_notification.rb +3 -3
- data/lib/stripe/resources/subscription.rb +23 -221
- data/lib/stripe/resources/subscription_item.rb +8 -27
- data/lib/stripe/resources/subscription_schedule.rb +11 -204
- 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/configuration.rb +0 -16
- 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 -18
- data/lib/stripe/resources/token.rb +4 -4
- data/lib/stripe/resources/topup.rb +3 -3
- data/lib/stripe/resources/transfer.rb +5 -7
- 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 -3
- data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
- 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 -35
- data/lib/stripe/resources/treasury/received_credit.rb +10 -40
- data/lib/stripe/resources/treasury/received_debit.rb +7 -39
- data/lib/stripe/resources/treasury/transaction.rb +11 -11
- data/lib/stripe/resources/treasury/transaction_entry.rb +11 -11
- data/lib/stripe/resources/v2/core/account.rb +133 -789
- 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/webhook_endpoint.rb +1 -1
- data/lib/stripe/resources.rb +0 -100
- data/lib/stripe/services/billing_service.rb +1 -2
- data/lib/stripe/services/financial_connections/account_service.rb +1 -3
- data/lib/stripe/services/financial_connections_service.rb +1 -2
- data/lib/stripe/services/issuing_service.rb +1 -5
- data/lib/stripe/services/mandate_service.rb +0 -5
- data/lib/stripe/services/payment_intent_service.rb +0 -37
- data/lib/stripe/services/payment_method_service.rb +1 -1
- data/lib/stripe/services/quote_service.rb +1 -49
- data/lib/stripe/services/subscription_schedule_service.rb +0 -11
- data/lib/stripe/services/subscription_service.rb +0 -11
- data/lib/stripe/services/tax_service.rb +1 -2
- data/lib/stripe/services/terminal_service.rb +1 -2
- data/lib/stripe/services/v1_services.rb +1 -8
- data/lib/stripe/services/v2/billing_service.rb +1 -5
- data/lib/stripe/services/v2/core/account_link_service.rb +1 -1
- data/lib/stripe/services/v2/core/account_service.rb +0 -4
- data/lib/stripe/services/v2/core/accounts/person_service.rb +2 -2
- data/lib/stripe/services/v2/core_service.rb +1 -2
- data/lib/stripe/services/v2_services.rb +1 -3
- data/lib/stripe/services.rb +0 -51
- data/lib/stripe/stripe_configuration.rb +1 -3
- data/lib/stripe/stripe_object.rb +31 -2
- data/lib/stripe/util.rb +1 -7
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe.rb +0 -53
- data/rbi/stripe.rbi +17422 -76304
- metadata +4 -301
- data/lib/stripe/events/v2_core_account_closed_event.rb +0 -44
- data/lib/stripe/events/v2_core_account_created_event.rb +0 -44
- data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +0 -63
- data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +0 -44
- data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +0 -63
- data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +0 -44
- data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +0 -63
- data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +0 -44
- data/lib/stripe/events/v2_core_account_including_configuration_storer_capability_status_updated_event.rb +0 -63
- data/lib/stripe/events/v2_core_account_including_configuration_storer_updated_event.rb +0 -44
- data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +0 -44
- data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +0 -44
- data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +0 -44
- data/lib/stripe/events/v2_core_account_link_returned_event.rb +0 -42
- data/lib/stripe/events/v2_core_account_person_created_event.rb +0 -61
- data/lib/stripe/events/v2_core_account_person_deleted_event.rb +0 -61
- data/lib/stripe/events/v2_core_account_person_updated_event.rb +0 -61
- data/lib/stripe/events/v2_core_account_updated_event.rb +0 -44
- data/lib/stripe/events/v2_core_health_event_generation_failure_resolved_event.rb +0 -78
- data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +0 -61
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_payout_method_updated_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +0 -61
- data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +0 -44
- data/lib/stripe/events/v2_money_management_transaction_created_event.rb +0 -61
- data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +0 -44
- data/lib/stripe/params/account_notice_list_params.rb +0 -25
- data/lib/stripe/params/account_notice_retrieve_params.rb +0 -13
- data/lib/stripe/params/account_notice_update_params.rb +0 -36
- data/lib/stripe/params/billing/analytics/meter_usage_retrieve_params.rb +0 -65
- data/lib/stripe/params/capital/financing_offer_list_params.rb +0 -58
- data/lib/stripe/params/capital/financing_offer_mark_delivered_params.rb +0 -15
- data/lib/stripe/params/capital/financing_offer_retrieve_params.rb +0 -15
- data/lib/stripe/params/capital/financing_summary_retrieve_params.rb +0 -15
- data/lib/stripe/params/capital/financing_transaction_list_params.rb +0 -45
- data/lib/stripe/params/capital/financing_transaction_retrieve_params.rb +0 -15
- data/lib/stripe/params/external_account_create_params.rb +0 -134
- data/lib/stripe/params/external_account_delete_params.rb +0 -6
- data/lib/stripe/params/external_account_list_params.rb +0 -25
- data/lib/stripe/params/external_account_retrieve_params.rb +0 -13
- data/lib/stripe/params/external_account_update_params.rb +0 -91
- data/lib/stripe/params/financial_connections/account_inferred_balance_list_params.rb +0 -24
- data/lib/stripe/params/financial_connections/institution_list_params.rb +0 -24
- data/lib/stripe/params/financial_connections/institution_retrieve_params.rb +0 -15
- data/lib/stripe/params/fx_quote_create_params.rb +0 -73
- data/lib/stripe/params/fx_quote_list_params.rb +0 -22
- data/lib/stripe/params/fx_quote_retrieve_params.rb +0 -13
- data/lib/stripe/params/issuing/credit_underwriting_record_correct_params.rb +0 -163
- data/lib/stripe/params/issuing/credit_underwriting_record_create_from_application_params.rb +0 -50
- data/lib/stripe/params/issuing/credit_underwriting_record_create_from_proactive_review_params.rb +0 -128
- data/lib/stripe/params/issuing/credit_underwriting_record_list_params.rb +0 -24
- data/lib/stripe/params/issuing/credit_underwriting_record_report_decision_params.rb +0 -86
- data/lib/stripe/params/issuing/credit_underwriting_record_retrieve_params.rb +0 -15
- data/lib/stripe/params/issuing/dispute_settlement_detail_list_params.rb +0 -33
- data/lib/stripe/params/issuing/dispute_settlement_detail_retrieve_params.rb +0 -15
- data/lib/stripe/params/issuing/fraud_liability_debit_list_params.rb +0 -44
- data/lib/stripe/params/issuing/fraud_liability_debit_retrieve_params.rb +0 -15
- data/lib/stripe/params/mandate_list_params.rb +0 -39
- data/lib/stripe/params/margin_create_params.rb +0 -25
- data/lib/stripe/params/margin_list_params.rb +0 -25
- data/lib/stripe/params/margin_retrieve_params.rb +0 -13
- data/lib/stripe/params/margin_update_params.rb +0 -22
- data/lib/stripe/params/order_cancel_params.rb +0 -13
- data/lib/stripe/params/order_create_params.rb +0 -2061
- data/lib/stripe/params/order_line_item_list_params.rb +0 -22
- data/lib/stripe/params/order_list_line_items_params.rb +0 -22
- data/lib/stripe/params/order_list_params.rb +0 -25
- data/lib/stripe/params/order_reopen_params.rb +0 -13
- data/lib/stripe/params/order_retrieve_params.rb +0 -13
- data/lib/stripe/params/order_submit_params.rb +0 -16
- data/lib/stripe/params/order_update_params.rb +0 -2065
- data/lib/stripe/params/payment_intent_decrement_authorization_params.rb +0 -73
- data/lib/stripe/params/payment_intent_trigger_action_params.rb +0 -27
- data/lib/stripe/params/privacy/redaction_job_cancel_params.rb +0 -15
- data/lib/stripe/params/privacy/redaction_job_create_params.rb +0 -67
- data/lib/stripe/params/privacy/redaction_job_list_params.rb +0 -27
- data/lib/stripe/params/privacy/redaction_job_retrieve_params.rb +0 -15
- data/lib/stripe/params/privacy/redaction_job_run_params.rb +0 -15
- data/lib/stripe/params/privacy/redaction_job_update_params.rb +0 -18
- data/lib/stripe/params/privacy/redaction_job_validate_params.rb +0 -15
- data/lib/stripe/params/privacy/redaction_job_validation_error_list_params.rb +0 -24
- data/lib/stripe/params/quote_line_list_params.rb +0 -22
- data/lib/stripe/params/quote_list_lines_params.rb +0 -22
- data/lib/stripe/params/quote_list_preview_invoice_lines_params.rb +0 -22
- data/lib/stripe/params/quote_mark_draft_params.rb +0 -13
- data/lib/stripe/params/quote_mark_stale_params.rb +0 -16
- data/lib/stripe/params/quote_preview_invoice_list_params.rb +0 -22
- data/lib/stripe/params/quote_preview_subscription_schedule_list_params.rb +0 -22
- data/lib/stripe/params/quote_reestimate_params.rb +0 -13
- data/lib/stripe/params/subscription_attach_cadence_params.rb +0 -16
- data/lib/stripe/params/subscription_schedule_amend_params.rb +0 -570
- data/lib/stripe/params/tax/form_list_params.rb +0 -51
- data/lib/stripe/params/tax/form_pdf_params.rb +0 -15
- data/lib/stripe/params/tax/form_retrieve_params.rb +0 -15
- data/lib/stripe/params/terminal/reader_collected_data_retrieve_params.rb +0 -15
- data/lib/stripe/params/v2/billing/bill_setting_create_params.rb +0 -74
- data/lib/stripe/params/v2/billing/bill_setting_list_params.rb +0 -21
- data/lib/stripe/params/v2/billing/bill_setting_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/billing/bill_setting_update_params.rb +0 -80
- data/lib/stripe/params/v2/billing/bill_settings/version_list_params.rb +0 -19
- data/lib/stripe/params/v2/billing/bill_settings/version_retrieve_params.rb +0 -12
- data/lib/stripe/params/v2/billing/cadence_cancel_params.rb +0 -10
- data/lib/stripe/params/v2/billing/cadence_create_params.rb +0 -253
- data/lib/stripe/params/v2/billing/cadence_list_params.rb +0 -43
- data/lib/stripe/params/v2/billing/cadence_retrieve_params.rb +0 -17
- data/lib/stripe/params/v2/billing/cadence_update_params.rb +0 -75
- data/lib/stripe/params/v2/billing/collection_setting_create_params.rb +0 -223
- data/lib/stripe/params/v2/billing/collection_setting_list_params.rb +0 -21
- data/lib/stripe/params/v2/billing/collection_setting_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/billing/collection_setting_update_params.rb +0 -229
- data/lib/stripe/params/v2/billing/collection_settings/version_list_params.rb +0 -19
- data/lib/stripe/params/v2/billing/collection_settings/version_retrieve_params.rb +0 -12
- data/lib/stripe/params/v2/billing/profile_create_params.rb +0 -37
- data/lib/stripe/params/v2/billing/profile_list_params.rb +0 -40
- data/lib/stripe/params/v2/billing/profile_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/billing/profile_update_params.rb +0 -35
- data/lib/stripe/params/v2/core/vault/gb_bank_account_acknowledge_confirmation_of_payee_params.rb +0 -12
- data/lib/stripe/params/v2/core/vault/gb_bank_account_archive_params.rb +0 -12
- data/lib/stripe/params/v2/core/vault/gb_bank_account_create_params.rb +0 -50
- data/lib/stripe/params/v2/core/vault/gb_bank_account_initiate_confirmation_of_payee_params.rb +0 -22
- data/lib/stripe/params/v2/core/vault/gb_bank_account_list_params.rb +0 -19
- data/lib/stripe/params/v2/core/vault/gb_bank_account_retrieve_params.rb +0 -12
- data/lib/stripe/params/v2/core/vault/us_bank_account_archive_params.rb +0 -12
- data/lib/stripe/params/v2/core/vault/us_bank_account_confirm_microdeposits_params.rb +0 -22
- data/lib/stripe/params/v2/core/vault/us_bank_account_create_params.rb +0 -33
- data/lib/stripe/params/v2/core/vault/us_bank_account_list_params.rb +0 -22
- data/lib/stripe/params/v2/core/vault/us_bank_account_retrieve_params.rb +0 -12
- data/lib/stripe/params/v2/core/vault/us_bank_account_send_microdeposits_params.rb +0 -12
- data/lib/stripe/params/v2/core/vault/us_bank_account_update_params.rb +0 -22
- data/lib/stripe/params/v2/money_management/adjustment_list_params.rb +0 -48
- data/lib/stripe/params/v2/money_management/adjustment_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/financial_account_close_params.rb +0 -28
- data/lib/stripe/params/v2/money_management/financial_account_create_params.rb +0 -34
- data/lib/stripe/params/v2/money_management/financial_account_list_params.rb +0 -20
- data/lib/stripe/params/v2/money_management/financial_account_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/financial_account_update_params.rb +0 -20
- data/lib/stripe/params/v2/money_management/financial_address_create_params.rb +0 -20
- data/lib/stripe/params/v2/money_management/financial_address_list_params.rb +0 -23
- data/lib/stripe/params/v2/money_management/financial_address_retrieve_params.rb +0 -17
- data/lib/stripe/params/v2/money_management/inbound_transfer_create_params.rb +0 -50
- data/lib/stripe/params/v2/money_management/inbound_transfer_list_params.rb +0 -44
- data/lib/stripe/params/v2/money_management/inbound_transfer_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/outbound_payment_cancel_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/outbound_payment_create_params.rb +0 -98
- data/lib/stripe/params/v2/money_management/outbound_payment_list_params.rb +0 -52
- data/lib/stripe/params/v2/money_management/outbound_payment_quote_create_params.rb +0 -67
- data/lib/stripe/params/v2/money_management/outbound_payment_quote_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/outbound_payment_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/outbound_setup_intent_cancel_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/outbound_setup_intent_create_params.rb +0 -85
- data/lib/stripe/params/v2/money_management/outbound_setup_intent_list_params.rb +0 -17
- data/lib/stripe/params/v2/money_management/outbound_setup_intent_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/outbound_setup_intent_update_params.rb +0 -80
- data/lib/stripe/params/v2/money_management/outbound_transfer_cancel_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/outbound_transfer_create_params.rb +0 -77
- data/lib/stripe/params/v2/money_management/outbound_transfer_list_params.rb +0 -48
- data/lib/stripe/params/v2/money_management/outbound_transfer_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/payout_method_archive_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/payout_method_list_params.rb +0 -31
- data/lib/stripe/params/v2/money_management/payout_method_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/payout_method_unarchive_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/payout_methods_bank_account_spec_retrieve_params.rb +0 -17
- data/lib/stripe/params/v2/money_management/received_credit_list_params.rb +0 -44
- data/lib/stripe/params/v2/money_management/received_credit_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/received_debit_list_params.rb +0 -17
- data/lib/stripe/params/v2/money_management/received_debit_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/transaction_entry_list_params.rb +0 -43
- data/lib/stripe/params/v2/money_management/transaction_entry_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/money_management/transaction_list_params.rb +0 -47
- data/lib/stripe/params/v2/money_management/transaction_retrieve_params.rb +0 -10
- data/lib/stripe/params/v2/test_helpers/financial_address_credit_params.rb +0 -23
- data/lib/stripe/params/v2/test_helpers/financial_address_generate_microdeposits_params.rb +0 -10
- data/lib/stripe/resources/account_notice.rb +0 -94
- data/lib/stripe/resources/billing/analytics/meter_usage.rb +0 -33
- data/lib/stripe/resources/billing/analytics/meter_usage_row.rb +0 -38
- data/lib/stripe/resources/capital/financing_offer.rb +0 -142
- data/lib/stripe/resources/capital/financing_summary.rb +0 -79
- data/lib/stripe/resources/capital/financing_transaction.rb +0 -99
- data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -35
- data/lib/stripe/resources/financial_connections/institution.rb +0 -127
- data/lib/stripe/resources/fx_quote.rb +0 -147
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -263
- data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -71
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -51
- data/lib/stripe/resources/issuing/settlement.rb +0 -61
- data/lib/stripe/resources/margin.rb +0 -64
- data/lib/stripe/resources/order.rb +0 -987
- data/lib/stripe/resources/privacy/redaction_job.rb +0 -187
- data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +0 -49
- data/lib/stripe/resources/quote_line.rb +0 -521
- data/lib/stripe/resources/quote_preview_invoice.rb +0 -1150
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -732
- data/lib/stripe/resources/tax/form.rb +0 -264
- data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -47
- data/lib/stripe/resources/v2/billing/bill_setting.rb +0 -102
- data/lib/stripe/resources/v2/billing/bill_setting_version.rb +0 -90
- data/lib/stripe/resources/v2/billing/cadence.rb +0 -609
- data/lib/stripe/resources/v2/billing/collection_setting.rb +0 -274
- data/lib/stripe/resources/v2/billing/collection_setting_version.rb +0 -262
- data/lib/stripe/resources/v2/billing/profile.rb +0 -46
- data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +0 -114
- data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +0 -81
- data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +0 -28
- data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +0 -30
- data/lib/stripe/resources/v2/money_management/adjustment.rb +0 -67
- data/lib/stripe/resources/v2/money_management/financial_account.rb +0 -140
- data/lib/stripe/resources/v2/money_management/financial_address.rb +0 -132
- data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +0 -148
- data/lib/stripe/resources/v2/money_management/outbound_payment.rb +0 -217
- data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +0 -144
- data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +0 -69
- data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +0 -196
- data/lib/stripe/resources/v2/money_management/payout_method.rb +0 -109
- data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +0 -81
- data/lib/stripe/resources/v2/money_management/received_credit.rb +0 -228
- data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -136
- data/lib/stripe/resources/v2/money_management/transaction.rb +0 -116
- data/lib/stripe/resources/v2/money_management/transaction_entry.rb +0 -105
- data/lib/stripe/services/account_notice_service.rb +0 -39
- data/lib/stripe/services/billing/analytics/meter_usage_service.rb +0 -21
- data/lib/stripe/services/billing/analytics_service.rb +0 -15
- data/lib/stripe/services/capital/financing_offer_service.rb +0 -42
- data/lib/stripe/services/capital/financing_summary_service.rb +0 -19
- data/lib/stripe/services/capital/financing_transaction_service.rb +0 -31
- data/lib/stripe/services/capital_service.rb +0 -15
- data/lib/stripe/services/external_account_service.rb +0 -68
- data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -19
- data/lib/stripe/services/financial_connections/institution_service.rb +0 -30
- data/lib/stripe/services/fx_quote_service.rb +0 -27
- data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -74
- data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -30
- data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -30
- data/lib/stripe/services/margin_service.rb +0 -50
- data/lib/stripe/services/order_line_item_service.rb +0 -17
- data/lib/stripe/services/order_service.rb +0 -78
- data/lib/stripe/services/privacy/redaction_job_service.rb +0 -104
- data/lib/stripe/services/privacy/redaction_job_validation_error_service.rb +0 -19
- data/lib/stripe/services/privacy_service.rb +0 -13
- data/lib/stripe/services/quote_line_service.rb +0 -17
- data/lib/stripe/services/quote_preview_invoice_service.rb +0 -17
- data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -17
- data/lib/stripe/services/tax/form_service.rb +0 -37
- data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -19
- data/lib/stripe/services/v2/billing/bill_setting_service.rb +0 -61
- data/lib/stripe/services/v2/billing/bill_settings/version_service.rb +0 -34
- data/lib/stripe/services/v2/billing/cadence_service.rb +0 -65
- data/lib/stripe/services/v2/billing/collection_setting_service.rb +0 -61
- data/lib/stripe/services/v2/billing/collection_settings/version_service.rb +0 -34
- data/lib/stripe/services/v2/billing/profile_service.rb +0 -54
- data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +0 -85
- data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +0 -101
- data/lib/stripe/services/v2/core/vault_service.rb +0 -18
- data/lib/stripe/services/v2/money_management/adjustment_service.rb +0 -32
- data/lib/stripe/services/v2/money_management/financial_account_service.rb +0 -70
- data/lib/stripe/services/v2/money_management/financial_address_service.rb +0 -46
- data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +0 -45
- data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +0 -34
- data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +0 -62
- data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +0 -73
- data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +0 -60
- data/lib/stripe/services/v2/money_management/payout_method_service.rb +0 -63
- data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +0 -23
- data/lib/stripe/services/v2/money_management/received_credit_service.rb +0 -32
- data/lib/stripe/services/v2/money_management/received_debit_service.rb +0 -32
- data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +0 -32
- data/lib/stripe/services/v2/money_management/transaction_service.rb +0 -32
- data/lib/stripe/services/v2/money_management_service.rb +0 -31
- data/lib/stripe/services/v2/test_helper_service.rb +0 -15
- data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +0 -36
|
@@ -15,7 +15,7 @@ module Stripe
|
|
|
15
15
|
@type = type
|
|
16
16
|
end
|
|
17
17
|
end
|
|
18
|
-
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/
|
|
18
|
+
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
|
|
19
19
|
attr_accessor :enabled
|
|
20
20
|
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
|
21
21
|
attr_accessor :liability
|
|
@@ -38,7 +38,7 @@ module Stripe
|
|
|
38
38
|
attr_accessor :line2
|
|
39
39
|
# ZIP or postal code.
|
|
40
40
|
attr_accessor :postal_code
|
|
41
|
-
# State, county, province, or region.
|
|
41
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
42
42
|
attr_accessor :state
|
|
43
43
|
|
|
44
44
|
def initialize(
|
|
@@ -70,7 +70,7 @@ module Stripe
|
|
|
70
70
|
attr_accessor :line2
|
|
71
71
|
# ZIP or postal code.
|
|
72
72
|
attr_accessor :postal_code
|
|
73
|
-
# State, county, province, or region.
|
|
73
|
+
# State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
|
|
74
74
|
attr_accessor :state
|
|
75
75
|
|
|
76
76
|
def initialize(
|
|
@@ -123,7 +123,7 @@ module Stripe
|
|
|
123
123
|
@value = value
|
|
124
124
|
end
|
|
125
125
|
end
|
|
126
|
-
# The customer's address.
|
|
126
|
+
# The customer's address. Learn about [country-specific requirements for calculating tax](/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer).
|
|
127
127
|
attr_accessor :address
|
|
128
128
|
# The customer's shipping information. Appears on invoices emailed to this customer.
|
|
129
129
|
attr_accessor :shipping
|
|
@@ -144,88 +144,32 @@ module Stripe
|
|
|
144
144
|
end
|
|
145
145
|
|
|
146
146
|
class Discount < ::Stripe::RequestParams
|
|
147
|
-
class DiscountEnd < ::Stripe::RequestParams
|
|
148
|
-
class Duration < ::Stripe::RequestParams
|
|
149
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
150
|
-
attr_accessor :interval
|
|
151
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
152
|
-
attr_accessor :interval_count
|
|
153
|
-
|
|
154
|
-
def initialize(interval: nil, interval_count: nil)
|
|
155
|
-
@interval = interval
|
|
156
|
-
@interval_count = interval_count
|
|
157
|
-
end
|
|
158
|
-
end
|
|
159
|
-
# Time span for the redeemed discount.
|
|
160
|
-
attr_accessor :duration
|
|
161
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
|
162
|
-
attr_accessor :timestamp
|
|
163
|
-
# The type of calculation made to determine when the discount ends.
|
|
164
|
-
attr_accessor :type
|
|
165
|
-
|
|
166
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
|
167
|
-
@duration = duration
|
|
168
|
-
@timestamp = timestamp
|
|
169
|
-
@type = type
|
|
170
|
-
end
|
|
171
|
-
end
|
|
172
147
|
# ID of the coupon to create a new discount for.
|
|
173
148
|
attr_accessor :coupon
|
|
174
149
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
175
150
|
attr_accessor :discount
|
|
176
|
-
# Details to determine how long the discount should be applied for.
|
|
177
|
-
attr_accessor :discount_end
|
|
178
151
|
# ID of the promotion code to create a new discount for.
|
|
179
152
|
attr_accessor :promotion_code
|
|
180
153
|
|
|
181
|
-
def initialize(coupon: nil, discount: nil,
|
|
154
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
|
182
155
|
@coupon = coupon
|
|
183
156
|
@discount = discount
|
|
184
|
-
@discount_end = discount_end
|
|
185
157
|
@promotion_code = promotion_code
|
|
186
158
|
end
|
|
187
159
|
end
|
|
188
160
|
|
|
189
161
|
class InvoiceItem < ::Stripe::RequestParams
|
|
190
162
|
class Discount < ::Stripe::RequestParams
|
|
191
|
-
class DiscountEnd < ::Stripe::RequestParams
|
|
192
|
-
class Duration < ::Stripe::RequestParams
|
|
193
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
194
|
-
attr_accessor :interval
|
|
195
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
196
|
-
attr_accessor :interval_count
|
|
197
|
-
|
|
198
|
-
def initialize(interval: nil, interval_count: nil)
|
|
199
|
-
@interval = interval
|
|
200
|
-
@interval_count = interval_count
|
|
201
|
-
end
|
|
202
|
-
end
|
|
203
|
-
# Time span for the redeemed discount.
|
|
204
|
-
attr_accessor :duration
|
|
205
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
|
206
|
-
attr_accessor :timestamp
|
|
207
|
-
# The type of calculation made to determine when the discount ends.
|
|
208
|
-
attr_accessor :type
|
|
209
|
-
|
|
210
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
|
211
|
-
@duration = duration
|
|
212
|
-
@timestamp = timestamp
|
|
213
|
-
@type = type
|
|
214
|
-
end
|
|
215
|
-
end
|
|
216
163
|
# ID of the coupon to create a new discount for.
|
|
217
164
|
attr_accessor :coupon
|
|
218
165
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
219
166
|
attr_accessor :discount
|
|
220
|
-
# Details to determine how long the discount should be applied for.
|
|
221
|
-
attr_accessor :discount_end
|
|
222
167
|
# ID of the promotion code to create a new discount for.
|
|
223
168
|
attr_accessor :promotion_code
|
|
224
169
|
|
|
225
|
-
def initialize(coupon: nil, discount: nil,
|
|
170
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
|
226
171
|
@coupon = coupon
|
|
227
172
|
@discount = discount
|
|
228
|
-
@discount_end = discount_end
|
|
229
173
|
@promotion_code = promotion_code
|
|
230
174
|
end
|
|
231
175
|
end
|
|
@@ -247,7 +191,7 @@ module Stripe
|
|
|
247
191
|
attr_accessor :currency
|
|
248
192
|
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
|
|
249
193
|
attr_accessor :product
|
|
250
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
194
|
+
# 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.
|
|
251
195
|
attr_accessor :tax_behavior
|
|
252
196
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
|
253
197
|
attr_accessor :unit_amount
|
|
@@ -280,19 +224,19 @@ module Stripe
|
|
|
280
224
|
attr_accessor :discounts
|
|
281
225
|
# The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.
|
|
282
226
|
attr_accessor :invoiceitem
|
|
283
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
227
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
284
228
|
attr_accessor :metadata
|
|
285
|
-
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/
|
|
229
|
+
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
|
|
286
230
|
attr_accessor :period
|
|
287
231
|
# The ID of the price object. One of `price` or `price_data` is required.
|
|
288
232
|
attr_accessor :price
|
|
289
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
233
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
290
234
|
attr_accessor :price_data
|
|
291
235
|
# Non-negative integer. The quantity of units for the invoice item.
|
|
292
236
|
attr_accessor :quantity
|
|
293
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
237
|
+
# 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.
|
|
294
238
|
attr_accessor :tax_behavior
|
|
295
|
-
# A [tax code](https://stripe.com/
|
|
239
|
+
# A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
|
|
296
240
|
attr_accessor :tax_code
|
|
297
241
|
# The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.
|
|
298
242
|
attr_accessor :tax_rates
|
|
@@ -351,458 +295,6 @@ module Stripe
|
|
|
351
295
|
end
|
|
352
296
|
|
|
353
297
|
class ScheduleDetails < ::Stripe::RequestParams
|
|
354
|
-
class Amendment < ::Stripe::RequestParams
|
|
355
|
-
class AmendmentEnd < ::Stripe::RequestParams
|
|
356
|
-
class DiscountEnd < ::Stripe::RequestParams
|
|
357
|
-
# The ID of a specific discount.
|
|
358
|
-
attr_accessor :discount
|
|
359
|
-
|
|
360
|
-
def initialize(discount: nil)
|
|
361
|
-
@discount = discount
|
|
362
|
-
end
|
|
363
|
-
end
|
|
364
|
-
|
|
365
|
-
class Duration < ::Stripe::RequestParams
|
|
366
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
367
|
-
attr_accessor :interval
|
|
368
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
369
|
-
attr_accessor :interval_count
|
|
370
|
-
|
|
371
|
-
def initialize(interval: nil, interval_count: nil)
|
|
372
|
-
@interval = interval
|
|
373
|
-
@interval_count = interval_count
|
|
374
|
-
end
|
|
375
|
-
end
|
|
376
|
-
# Use the `end` time of a given discount.
|
|
377
|
-
attr_accessor :discount_end
|
|
378
|
-
# Time span for the amendment starting from the `amendment_start`.
|
|
379
|
-
attr_accessor :duration
|
|
380
|
-
# A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
|
381
|
-
attr_accessor :timestamp
|
|
382
|
-
# Select one of three ways to pass the `amendment_end`.
|
|
383
|
-
attr_accessor :type
|
|
384
|
-
|
|
385
|
-
def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil)
|
|
386
|
-
@discount_end = discount_end
|
|
387
|
-
@duration = duration
|
|
388
|
-
@timestamp = timestamp
|
|
389
|
-
@type = type
|
|
390
|
-
end
|
|
391
|
-
end
|
|
392
|
-
|
|
393
|
-
class AmendmentStart < ::Stripe::RequestParams
|
|
394
|
-
class AmendmentEnd < ::Stripe::RequestParams
|
|
395
|
-
# The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.
|
|
396
|
-
attr_accessor :index
|
|
397
|
-
|
|
398
|
-
def initialize(index: nil)
|
|
399
|
-
@index = index
|
|
400
|
-
end
|
|
401
|
-
end
|
|
402
|
-
|
|
403
|
-
class DiscountEnd < ::Stripe::RequestParams
|
|
404
|
-
# The ID of a specific discount.
|
|
405
|
-
attr_accessor :discount
|
|
406
|
-
|
|
407
|
-
def initialize(discount: nil)
|
|
408
|
-
@discount = discount
|
|
409
|
-
end
|
|
410
|
-
end
|
|
411
|
-
# Details of another amendment in the same array, immediately after which this amendment should begin.
|
|
412
|
-
attr_accessor :amendment_end
|
|
413
|
-
# Use the `end` time of a given discount.
|
|
414
|
-
attr_accessor :discount_end
|
|
415
|
-
# A precise Unix timestamp for the amendment to start.
|
|
416
|
-
attr_accessor :timestamp
|
|
417
|
-
# Select one of three ways to pass the `amendment_start`.
|
|
418
|
-
attr_accessor :type
|
|
419
|
-
|
|
420
|
-
def initialize(amendment_end: nil, discount_end: nil, timestamp: nil, type: nil)
|
|
421
|
-
@amendment_end = amendment_end
|
|
422
|
-
@discount_end = discount_end
|
|
423
|
-
@timestamp = timestamp
|
|
424
|
-
@type = type
|
|
425
|
-
end
|
|
426
|
-
end
|
|
427
|
-
|
|
428
|
-
class DiscountAction < ::Stripe::RequestParams
|
|
429
|
-
class Add < ::Stripe::RequestParams
|
|
430
|
-
class DiscountEnd < ::Stripe::RequestParams
|
|
431
|
-
# The type of calculation made to determine when the discount ends.
|
|
432
|
-
attr_accessor :type
|
|
433
|
-
|
|
434
|
-
def initialize(type: nil)
|
|
435
|
-
@type = type
|
|
436
|
-
end
|
|
437
|
-
end
|
|
438
|
-
# The coupon code to redeem.
|
|
439
|
-
attr_accessor :coupon
|
|
440
|
-
# An ID of an existing discount for a coupon that was already redeemed.
|
|
441
|
-
attr_accessor :discount
|
|
442
|
-
# Details to determine how long the discount should be applied for.
|
|
443
|
-
attr_accessor :discount_end
|
|
444
|
-
# The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
|
|
445
|
-
attr_accessor :index
|
|
446
|
-
# The promotion code to redeem.
|
|
447
|
-
attr_accessor :promotion_code
|
|
448
|
-
|
|
449
|
-
def initialize(
|
|
450
|
-
coupon: nil,
|
|
451
|
-
discount: nil,
|
|
452
|
-
discount_end: nil,
|
|
453
|
-
index: nil,
|
|
454
|
-
promotion_code: nil
|
|
455
|
-
)
|
|
456
|
-
@coupon = coupon
|
|
457
|
-
@discount = discount
|
|
458
|
-
@discount_end = discount_end
|
|
459
|
-
@index = index
|
|
460
|
-
@promotion_code = promotion_code
|
|
461
|
-
end
|
|
462
|
-
end
|
|
463
|
-
|
|
464
|
-
class Remove < ::Stripe::RequestParams
|
|
465
|
-
# The coupon code to remove from the `discounts` array.
|
|
466
|
-
attr_accessor :coupon
|
|
467
|
-
# The ID of a discount to remove from the `discounts` array.
|
|
468
|
-
attr_accessor :discount
|
|
469
|
-
# The ID of a promotion code to remove from the `discounts` array.
|
|
470
|
-
attr_accessor :promotion_code
|
|
471
|
-
|
|
472
|
-
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
|
473
|
-
@coupon = coupon
|
|
474
|
-
@discount = discount
|
|
475
|
-
@promotion_code = promotion_code
|
|
476
|
-
end
|
|
477
|
-
end
|
|
478
|
-
|
|
479
|
-
class Set < ::Stripe::RequestParams
|
|
480
|
-
# The coupon code to replace the `discounts` array with.
|
|
481
|
-
attr_accessor :coupon
|
|
482
|
-
# An ID of an existing discount to replace the `discounts` array with.
|
|
483
|
-
attr_accessor :discount
|
|
484
|
-
# An ID of an existing promotion code to replace the `discounts` array with.
|
|
485
|
-
attr_accessor :promotion_code
|
|
486
|
-
|
|
487
|
-
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
|
488
|
-
@coupon = coupon
|
|
489
|
-
@discount = discount
|
|
490
|
-
@promotion_code = promotion_code
|
|
491
|
-
end
|
|
492
|
-
end
|
|
493
|
-
# Details of the discount to add.
|
|
494
|
-
attr_accessor :add
|
|
495
|
-
# Details of the discount to remove.
|
|
496
|
-
attr_accessor :remove
|
|
497
|
-
# Details of the discount to replace the existing discounts with.
|
|
498
|
-
attr_accessor :set
|
|
499
|
-
# Determines the type of discount action.
|
|
500
|
-
attr_accessor :type
|
|
501
|
-
|
|
502
|
-
def initialize(add: nil, remove: nil, set: nil, type: nil)
|
|
503
|
-
@add = add
|
|
504
|
-
@remove = remove
|
|
505
|
-
@set = set
|
|
506
|
-
@type = type
|
|
507
|
-
end
|
|
508
|
-
end
|
|
509
|
-
|
|
510
|
-
class ItemAction < ::Stripe::RequestParams
|
|
511
|
-
class Add < ::Stripe::RequestParams
|
|
512
|
-
class Discount < ::Stripe::RequestParams
|
|
513
|
-
class DiscountEnd < ::Stripe::RequestParams
|
|
514
|
-
class Duration < ::Stripe::RequestParams
|
|
515
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
516
|
-
attr_accessor :interval
|
|
517
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
518
|
-
attr_accessor :interval_count
|
|
519
|
-
|
|
520
|
-
def initialize(interval: nil, interval_count: nil)
|
|
521
|
-
@interval = interval
|
|
522
|
-
@interval_count = interval_count
|
|
523
|
-
end
|
|
524
|
-
end
|
|
525
|
-
# Time span for the redeemed discount.
|
|
526
|
-
attr_accessor :duration
|
|
527
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
|
528
|
-
attr_accessor :timestamp
|
|
529
|
-
# The type of calculation made to determine when the discount ends.
|
|
530
|
-
attr_accessor :type
|
|
531
|
-
|
|
532
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
|
533
|
-
@duration = duration
|
|
534
|
-
@timestamp = timestamp
|
|
535
|
-
@type = type
|
|
536
|
-
end
|
|
537
|
-
end
|
|
538
|
-
# ID of the coupon to create a new discount for.
|
|
539
|
-
attr_accessor :coupon
|
|
540
|
-
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
541
|
-
attr_accessor :discount
|
|
542
|
-
# Details to determine how long the discount should be applied for.
|
|
543
|
-
attr_accessor :discount_end
|
|
544
|
-
# ID of the promotion code to create a new discount for.
|
|
545
|
-
attr_accessor :promotion_code
|
|
546
|
-
|
|
547
|
-
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
|
|
548
|
-
@coupon = coupon
|
|
549
|
-
@discount = discount
|
|
550
|
-
@discount_end = discount_end
|
|
551
|
-
@promotion_code = promotion_code
|
|
552
|
-
end
|
|
553
|
-
end
|
|
554
|
-
|
|
555
|
-
class Trial < ::Stripe::RequestParams
|
|
556
|
-
# 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.
|
|
557
|
-
attr_accessor :converts_to
|
|
558
|
-
# Determines the type of trial for this item.
|
|
559
|
-
attr_accessor :type
|
|
560
|
-
|
|
561
|
-
def initialize(converts_to: nil, type: nil)
|
|
562
|
-
@converts_to = converts_to
|
|
563
|
-
@type = type
|
|
564
|
-
end
|
|
565
|
-
end
|
|
566
|
-
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
|
567
|
-
attr_accessor :discounts
|
|
568
|
-
# Set of [key-value pairs](https://stripe.com/docs/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`.
|
|
569
|
-
attr_accessor :metadata
|
|
570
|
-
# The ID of the price object.
|
|
571
|
-
attr_accessor :price
|
|
572
|
-
# Quantity for this item.
|
|
573
|
-
attr_accessor :quantity
|
|
574
|
-
# The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
|
|
575
|
-
attr_accessor :tax_rates
|
|
576
|
-
# Options that configure the trial on the subscription item.
|
|
577
|
-
attr_accessor :trial
|
|
578
|
-
|
|
579
|
-
def initialize(
|
|
580
|
-
discounts: nil,
|
|
581
|
-
metadata: nil,
|
|
582
|
-
price: nil,
|
|
583
|
-
quantity: nil,
|
|
584
|
-
tax_rates: nil,
|
|
585
|
-
trial: nil
|
|
586
|
-
)
|
|
587
|
-
@discounts = discounts
|
|
588
|
-
@metadata = metadata
|
|
589
|
-
@price = price
|
|
590
|
-
@quantity = quantity
|
|
591
|
-
@tax_rates = tax_rates
|
|
592
|
-
@trial = trial
|
|
593
|
-
end
|
|
594
|
-
end
|
|
595
|
-
|
|
596
|
-
class Remove < ::Stripe::RequestParams
|
|
597
|
-
# ID of a price to remove.
|
|
598
|
-
attr_accessor :price
|
|
599
|
-
|
|
600
|
-
def initialize(price: nil)
|
|
601
|
-
@price = price
|
|
602
|
-
end
|
|
603
|
-
end
|
|
604
|
-
|
|
605
|
-
class Set < ::Stripe::RequestParams
|
|
606
|
-
class Discount < ::Stripe::RequestParams
|
|
607
|
-
class DiscountEnd < ::Stripe::RequestParams
|
|
608
|
-
class Duration < ::Stripe::RequestParams
|
|
609
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
610
|
-
attr_accessor :interval
|
|
611
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
612
|
-
attr_accessor :interval_count
|
|
613
|
-
|
|
614
|
-
def initialize(interval: nil, interval_count: nil)
|
|
615
|
-
@interval = interval
|
|
616
|
-
@interval_count = interval_count
|
|
617
|
-
end
|
|
618
|
-
end
|
|
619
|
-
# Time span for the redeemed discount.
|
|
620
|
-
attr_accessor :duration
|
|
621
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
|
622
|
-
attr_accessor :timestamp
|
|
623
|
-
# The type of calculation made to determine when the discount ends.
|
|
624
|
-
attr_accessor :type
|
|
625
|
-
|
|
626
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
|
627
|
-
@duration = duration
|
|
628
|
-
@timestamp = timestamp
|
|
629
|
-
@type = type
|
|
630
|
-
end
|
|
631
|
-
end
|
|
632
|
-
# ID of the coupon to create a new discount for.
|
|
633
|
-
attr_accessor :coupon
|
|
634
|
-
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
635
|
-
attr_accessor :discount
|
|
636
|
-
# Details to determine how long the discount should be applied for.
|
|
637
|
-
attr_accessor :discount_end
|
|
638
|
-
# ID of the promotion code to create a new discount for.
|
|
639
|
-
attr_accessor :promotion_code
|
|
640
|
-
|
|
641
|
-
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
|
|
642
|
-
@coupon = coupon
|
|
643
|
-
@discount = discount
|
|
644
|
-
@discount_end = discount_end
|
|
645
|
-
@promotion_code = promotion_code
|
|
646
|
-
end
|
|
647
|
-
end
|
|
648
|
-
|
|
649
|
-
class Trial < ::Stripe::RequestParams
|
|
650
|
-
# 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.
|
|
651
|
-
attr_accessor :converts_to
|
|
652
|
-
# Determines the type of trial for this item.
|
|
653
|
-
attr_accessor :type
|
|
654
|
-
|
|
655
|
-
def initialize(converts_to: nil, type: nil)
|
|
656
|
-
@converts_to = converts_to
|
|
657
|
-
@type = type
|
|
658
|
-
end
|
|
659
|
-
end
|
|
660
|
-
# If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
|
|
661
|
-
attr_accessor :discounts
|
|
662
|
-
# If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
|
|
663
|
-
attr_accessor :metadata
|
|
664
|
-
# The ID of the price object.
|
|
665
|
-
attr_accessor :price
|
|
666
|
-
# If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
|
|
667
|
-
attr_accessor :quantity
|
|
668
|
-
# If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
|
|
669
|
-
attr_accessor :tax_rates
|
|
670
|
-
# If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
|
|
671
|
-
attr_accessor :trial
|
|
672
|
-
|
|
673
|
-
def initialize(
|
|
674
|
-
discounts: nil,
|
|
675
|
-
metadata: nil,
|
|
676
|
-
price: nil,
|
|
677
|
-
quantity: nil,
|
|
678
|
-
tax_rates: nil,
|
|
679
|
-
trial: nil
|
|
680
|
-
)
|
|
681
|
-
@discounts = discounts
|
|
682
|
-
@metadata = metadata
|
|
683
|
-
@price = price
|
|
684
|
-
@quantity = quantity
|
|
685
|
-
@tax_rates = tax_rates
|
|
686
|
-
@trial = trial
|
|
687
|
-
end
|
|
688
|
-
end
|
|
689
|
-
# Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
|
|
690
|
-
attr_accessor :add
|
|
691
|
-
# Details of the subscription item to remove.
|
|
692
|
-
attr_accessor :remove
|
|
693
|
-
# Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
|
|
694
|
-
attr_accessor :set
|
|
695
|
-
# Determines the type of item action.
|
|
696
|
-
attr_accessor :type
|
|
697
|
-
|
|
698
|
-
def initialize(add: nil, remove: nil, set: nil, type: nil)
|
|
699
|
-
@add = add
|
|
700
|
-
@remove = remove
|
|
701
|
-
@set = set
|
|
702
|
-
@type = type
|
|
703
|
-
end
|
|
704
|
-
end
|
|
705
|
-
|
|
706
|
-
class MetadataAction < ::Stripe::RequestParams
|
|
707
|
-
# Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
|
708
|
-
attr_accessor :add
|
|
709
|
-
# Keys to remove from schedule phase metadata.
|
|
710
|
-
attr_accessor :remove
|
|
711
|
-
# Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
|
712
|
-
attr_accessor :set
|
|
713
|
-
# Select one of three ways to update phase-level `metadata` on subscription schedules.
|
|
714
|
-
attr_accessor :type
|
|
715
|
-
|
|
716
|
-
def initialize(add: nil, remove: nil, set: nil, type: nil)
|
|
717
|
-
@add = add
|
|
718
|
-
@remove = remove
|
|
719
|
-
@set = set
|
|
720
|
-
@type = type
|
|
721
|
-
end
|
|
722
|
-
end
|
|
723
|
-
|
|
724
|
-
class SetPauseCollection < ::Stripe::RequestParams
|
|
725
|
-
class Set < ::Stripe::RequestParams
|
|
726
|
-
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
|
727
|
-
attr_accessor :behavior
|
|
728
|
-
|
|
729
|
-
def initialize(behavior: nil)
|
|
730
|
-
@behavior = behavior
|
|
731
|
-
end
|
|
732
|
-
end
|
|
733
|
-
# Details of the pause_collection behavior to apply to the amendment.
|
|
734
|
-
attr_accessor :set
|
|
735
|
-
# Determines the type of the pause_collection amendment.
|
|
736
|
-
attr_accessor :type
|
|
737
|
-
|
|
738
|
-
def initialize(set: nil, type: nil)
|
|
739
|
-
@set = set
|
|
740
|
-
@type = type
|
|
741
|
-
end
|
|
742
|
-
end
|
|
743
|
-
|
|
744
|
-
class TrialSettings < ::Stripe::RequestParams
|
|
745
|
-
class EndBehavior < ::Stripe::RequestParams
|
|
746
|
-
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
747
|
-
attr_accessor :prorate_up_front
|
|
748
|
-
|
|
749
|
-
def initialize(prorate_up_front: nil)
|
|
750
|
-
@prorate_up_front = prorate_up_front
|
|
751
|
-
end
|
|
752
|
-
end
|
|
753
|
-
# Defines how the subscription should behave when a trial ends.
|
|
754
|
-
attr_accessor :end_behavior
|
|
755
|
-
|
|
756
|
-
def initialize(end_behavior: nil)
|
|
757
|
-
@end_behavior = end_behavior
|
|
758
|
-
end
|
|
759
|
-
end
|
|
760
|
-
# Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
|
|
761
|
-
attr_accessor :amendment_end
|
|
762
|
-
# Details to identify the earliest timestamp where the proposed change should take effect.
|
|
763
|
-
attr_accessor :amendment_start
|
|
764
|
-
# For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
|
|
765
|
-
attr_accessor :billing_cycle_anchor
|
|
766
|
-
# Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
|
767
|
-
attr_accessor :discount_actions
|
|
768
|
-
# Changes to the subscription items during the amendment time span.
|
|
769
|
-
attr_accessor :item_actions
|
|
770
|
-
# Instructions for how to modify phase metadata
|
|
771
|
-
attr_accessor :metadata_actions
|
|
772
|
-
# Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
|
|
773
|
-
attr_accessor :proration_behavior
|
|
774
|
-
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
|
775
|
-
attr_accessor :set_pause_collection
|
|
776
|
-
# Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
|
777
|
-
attr_accessor :set_schedule_end
|
|
778
|
-
# Settings related to subscription trials.
|
|
779
|
-
attr_accessor :trial_settings
|
|
780
|
-
|
|
781
|
-
def initialize(
|
|
782
|
-
amendment_end: nil,
|
|
783
|
-
amendment_start: nil,
|
|
784
|
-
billing_cycle_anchor: nil,
|
|
785
|
-
discount_actions: nil,
|
|
786
|
-
item_actions: nil,
|
|
787
|
-
metadata_actions: nil,
|
|
788
|
-
proration_behavior: nil,
|
|
789
|
-
set_pause_collection: nil,
|
|
790
|
-
set_schedule_end: nil,
|
|
791
|
-
trial_settings: nil
|
|
792
|
-
)
|
|
793
|
-
@amendment_end = amendment_end
|
|
794
|
-
@amendment_start = amendment_start
|
|
795
|
-
@billing_cycle_anchor = billing_cycle_anchor
|
|
796
|
-
@discount_actions = discount_actions
|
|
797
|
-
@item_actions = item_actions
|
|
798
|
-
@metadata_actions = metadata_actions
|
|
799
|
-
@proration_behavior = proration_behavior
|
|
800
|
-
@set_pause_collection = set_pause_collection
|
|
801
|
-
@set_schedule_end = set_schedule_end
|
|
802
|
-
@trial_settings = trial_settings
|
|
803
|
-
end
|
|
804
|
-
end
|
|
805
|
-
|
|
806
298
|
class BillingMode < ::Stripe::RequestParams
|
|
807
299
|
class Flexible < ::Stripe::RequestParams
|
|
808
300
|
# Controls how invoices and invoice items display proration amounts and discount amounts.
|
|
@@ -826,44 +318,16 @@ module Stripe
|
|
|
826
318
|
class Phase < ::Stripe::RequestParams
|
|
827
319
|
class AddInvoiceItem < ::Stripe::RequestParams
|
|
828
320
|
class Discount < ::Stripe::RequestParams
|
|
829
|
-
class DiscountEnd < ::Stripe::RequestParams
|
|
830
|
-
class Duration < ::Stripe::RequestParams
|
|
831
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
832
|
-
attr_accessor :interval
|
|
833
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
834
|
-
attr_accessor :interval_count
|
|
835
|
-
|
|
836
|
-
def initialize(interval: nil, interval_count: nil)
|
|
837
|
-
@interval = interval
|
|
838
|
-
@interval_count = interval_count
|
|
839
|
-
end
|
|
840
|
-
end
|
|
841
|
-
# Time span for the redeemed discount.
|
|
842
|
-
attr_accessor :duration
|
|
843
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
|
844
|
-
attr_accessor :timestamp
|
|
845
|
-
# The type of calculation made to determine when the discount ends.
|
|
846
|
-
attr_accessor :type
|
|
847
|
-
|
|
848
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
|
849
|
-
@duration = duration
|
|
850
|
-
@timestamp = timestamp
|
|
851
|
-
@type = type
|
|
852
|
-
end
|
|
853
|
-
end
|
|
854
321
|
# ID of the coupon to create a new discount for.
|
|
855
322
|
attr_accessor :coupon
|
|
856
323
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
857
324
|
attr_accessor :discount
|
|
858
|
-
# Details to determine how long the discount should be applied for.
|
|
859
|
-
attr_accessor :discount_end
|
|
860
325
|
# ID of the promotion code to create a new discount for.
|
|
861
326
|
attr_accessor :promotion_code
|
|
862
327
|
|
|
863
|
-
def initialize(coupon: nil, discount: nil,
|
|
328
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
|
864
329
|
@coupon = coupon
|
|
865
330
|
@discount = discount
|
|
866
|
-
@discount_end = discount_end
|
|
867
331
|
@promotion_code = promotion_code
|
|
868
332
|
end
|
|
869
333
|
end
|
|
@@ -908,7 +372,7 @@ module Stripe
|
|
|
908
372
|
attr_accessor :currency
|
|
909
373
|
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
|
|
910
374
|
attr_accessor :product
|
|
911
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
375
|
+
# 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.
|
|
912
376
|
attr_accessor :tax_behavior
|
|
913
377
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
|
|
914
378
|
attr_accessor :unit_amount
|
|
@@ -931,13 +395,13 @@ module Stripe
|
|
|
931
395
|
end
|
|
932
396
|
# The coupons to redeem into discounts for the item.
|
|
933
397
|
attr_accessor :discounts
|
|
934
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
398
|
+
# 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`.
|
|
935
399
|
attr_accessor :metadata
|
|
936
400
|
# The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
|
|
937
401
|
attr_accessor :period
|
|
938
402
|
# The ID of the price object. One of `price` or `price_data` is required.
|
|
939
403
|
attr_accessor :price
|
|
940
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
404
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
941
405
|
attr_accessor :price_data
|
|
942
406
|
# Quantity for this item. Defaults to 1.
|
|
943
407
|
attr_accessor :quantity
|
|
@@ -999,44 +463,16 @@ module Stripe
|
|
|
999
463
|
end
|
|
1000
464
|
|
|
1001
465
|
class Discount < ::Stripe::RequestParams
|
|
1002
|
-
class DiscountEnd < ::Stripe::RequestParams
|
|
1003
|
-
class Duration < ::Stripe::RequestParams
|
|
1004
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1005
|
-
attr_accessor :interval
|
|
1006
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1007
|
-
attr_accessor :interval_count
|
|
1008
|
-
|
|
1009
|
-
def initialize(interval: nil, interval_count: nil)
|
|
1010
|
-
@interval = interval
|
|
1011
|
-
@interval_count = interval_count
|
|
1012
|
-
end
|
|
1013
|
-
end
|
|
1014
|
-
# Time span for the redeemed discount.
|
|
1015
|
-
attr_accessor :duration
|
|
1016
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1017
|
-
attr_accessor :timestamp
|
|
1018
|
-
# The type of calculation made to determine when the discount ends.
|
|
1019
|
-
attr_accessor :type
|
|
1020
|
-
|
|
1021
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
|
1022
|
-
@duration = duration
|
|
1023
|
-
@timestamp = timestamp
|
|
1024
|
-
@type = type
|
|
1025
|
-
end
|
|
1026
|
-
end
|
|
1027
466
|
# ID of the coupon to create a new discount for.
|
|
1028
467
|
attr_accessor :coupon
|
|
1029
468
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1030
469
|
attr_accessor :discount
|
|
1031
|
-
# Details to determine how long the discount should be applied for.
|
|
1032
|
-
attr_accessor :discount_end
|
|
1033
470
|
# ID of the promotion code to create a new discount for.
|
|
1034
471
|
attr_accessor :promotion_code
|
|
1035
472
|
|
|
1036
|
-
def initialize(coupon: nil, discount: nil,
|
|
473
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
|
1037
474
|
@coupon = coupon
|
|
1038
475
|
@discount = discount
|
|
1039
|
-
@discount_end = discount_end
|
|
1040
476
|
@promotion_code = promotion_code
|
|
1041
477
|
end
|
|
1042
478
|
end
|
|
@@ -1081,7 +517,7 @@ module Stripe
|
|
|
1081
517
|
|
|
1082
518
|
class Item < ::Stripe::RequestParams
|
|
1083
519
|
class BillingThresholds < ::Stripe::RequestParams
|
|
1084
|
-
# Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/
|
|
520
|
+
# Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
|
1085
521
|
attr_accessor :usage_gte
|
|
1086
522
|
|
|
1087
523
|
def initialize(usage_gte: nil)
|
|
@@ -1090,44 +526,16 @@ module Stripe
|
|
|
1090
526
|
end
|
|
1091
527
|
|
|
1092
528
|
class Discount < ::Stripe::RequestParams
|
|
1093
|
-
class DiscountEnd < ::Stripe::RequestParams
|
|
1094
|
-
class Duration < ::Stripe::RequestParams
|
|
1095
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1096
|
-
attr_accessor :interval
|
|
1097
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1098
|
-
attr_accessor :interval_count
|
|
1099
|
-
|
|
1100
|
-
def initialize(interval: nil, interval_count: nil)
|
|
1101
|
-
@interval = interval
|
|
1102
|
-
@interval_count = interval_count
|
|
1103
|
-
end
|
|
1104
|
-
end
|
|
1105
|
-
# Time span for the redeemed discount.
|
|
1106
|
-
attr_accessor :duration
|
|
1107
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1108
|
-
attr_accessor :timestamp
|
|
1109
|
-
# The type of calculation made to determine when the discount ends.
|
|
1110
|
-
attr_accessor :type
|
|
1111
|
-
|
|
1112
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
|
1113
|
-
@duration = duration
|
|
1114
|
-
@timestamp = timestamp
|
|
1115
|
-
@type = type
|
|
1116
|
-
end
|
|
1117
|
-
end
|
|
1118
529
|
# ID of the coupon to create a new discount for.
|
|
1119
530
|
attr_accessor :coupon
|
|
1120
531
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1121
532
|
attr_accessor :discount
|
|
1122
|
-
# Details to determine how long the discount should be applied for.
|
|
1123
|
-
attr_accessor :discount_end
|
|
1124
533
|
# ID of the promotion code to create a new discount for.
|
|
1125
534
|
attr_accessor :promotion_code
|
|
1126
535
|
|
|
1127
|
-
def initialize(coupon: nil, discount: nil,
|
|
536
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
|
1128
537
|
@coupon = coupon
|
|
1129
538
|
@discount = discount
|
|
1130
|
-
@discount_end = discount_end
|
|
1131
539
|
@promotion_code = promotion_code
|
|
1132
540
|
end
|
|
1133
541
|
end
|
|
@@ -1150,7 +558,7 @@ module Stripe
|
|
|
1150
558
|
attr_accessor :product
|
|
1151
559
|
# The recurring components of a price such as `interval` and `interval_count`.
|
|
1152
560
|
attr_accessor :recurring
|
|
1153
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
561
|
+
# 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.
|
|
1154
562
|
attr_accessor :tax_behavior
|
|
1155
563
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
|
1156
564
|
attr_accessor :unit_amount
|
|
@@ -1173,36 +581,22 @@ module Stripe
|
|
|
1173
581
|
@unit_amount_decimal = unit_amount_decimal
|
|
1174
582
|
end
|
|
1175
583
|
end
|
|
1176
|
-
|
|
1177
|
-
class Trial < ::Stripe::RequestParams
|
|
1178
|
-
# 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.
|
|
1179
|
-
attr_accessor :converts_to
|
|
1180
|
-
# Determines the type of trial for this item.
|
|
1181
|
-
attr_accessor :type
|
|
1182
|
-
|
|
1183
|
-
def initialize(converts_to: nil, type: nil)
|
|
1184
|
-
@converts_to = converts_to
|
|
1185
|
-
@type = type
|
|
1186
|
-
end
|
|
1187
|
-
end
|
|
1188
584
|
# 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.
|
|
1189
585
|
attr_accessor :billing_thresholds
|
|
1190
586
|
# The coupons to redeem into discounts for the subscription item.
|
|
1191
587
|
attr_accessor :discounts
|
|
1192
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
588
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
|
|
1193
589
|
attr_accessor :metadata
|
|
1194
590
|
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
|
|
1195
591
|
attr_accessor :plan
|
|
1196
592
|
# The ID of the price object.
|
|
1197
593
|
attr_accessor :price
|
|
1198
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
594
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
|
|
1199
595
|
attr_accessor :price_data
|
|
1200
596
|
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
|
|
1201
597
|
attr_accessor :quantity
|
|
1202
|
-
# A list of [Tax Rate](https://stripe.com/
|
|
598
|
+
# A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
1203
599
|
attr_accessor :tax_rates
|
|
1204
|
-
# Options that configure the trial on the subscription item.
|
|
1205
|
-
attr_accessor :trial
|
|
1206
600
|
|
|
1207
601
|
def initialize(
|
|
1208
602
|
billing_thresholds: nil,
|
|
@@ -1212,8 +606,7 @@ module Stripe
|
|
|
1212
606
|
price: nil,
|
|
1213
607
|
price_data: nil,
|
|
1214
608
|
quantity: nil,
|
|
1215
|
-
tax_rates: nil
|
|
1216
|
-
trial: nil
|
|
609
|
+
tax_rates: nil
|
|
1217
610
|
)
|
|
1218
611
|
@billing_thresholds = billing_thresholds
|
|
1219
612
|
@discounts = discounts
|
|
@@ -1223,16 +616,6 @@ module Stripe
|
|
|
1223
616
|
@price_data = price_data
|
|
1224
617
|
@quantity = quantity
|
|
1225
618
|
@tax_rates = tax_rates
|
|
1226
|
-
@trial = trial
|
|
1227
|
-
end
|
|
1228
|
-
end
|
|
1229
|
-
|
|
1230
|
-
class PauseCollection < ::Stripe::RequestParams
|
|
1231
|
-
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
|
1232
|
-
attr_accessor :behavior
|
|
1233
|
-
|
|
1234
|
-
def initialize(behavior: nil)
|
|
1235
|
-
@behavior = behavior
|
|
1236
619
|
end
|
|
1237
620
|
end
|
|
1238
621
|
|
|
@@ -1247,30 +630,13 @@ module Stripe
|
|
|
1247
630
|
@destination = destination
|
|
1248
631
|
end
|
|
1249
632
|
end
|
|
1250
|
-
|
|
1251
|
-
class TrialSettings < ::Stripe::RequestParams
|
|
1252
|
-
class EndBehavior < ::Stripe::RequestParams
|
|
1253
|
-
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
|
1254
|
-
attr_accessor :prorate_up_front
|
|
1255
|
-
|
|
1256
|
-
def initialize(prorate_up_front: nil)
|
|
1257
|
-
@prorate_up_front = prorate_up_front
|
|
1258
|
-
end
|
|
1259
|
-
end
|
|
1260
|
-
# Defines how the subscription should behave when a trial ends.
|
|
1261
|
-
attr_accessor :end_behavior
|
|
1262
|
-
|
|
1263
|
-
def initialize(end_behavior: nil)
|
|
1264
|
-
@end_behavior = end_behavior
|
|
1265
|
-
end
|
|
1266
|
-
end
|
|
1267
633
|
# 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.
|
|
1268
634
|
attr_accessor :add_invoice_items
|
|
1269
635
|
# 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).
|
|
1270
636
|
attr_accessor :application_fee_percent
|
|
1271
637
|
# Automatic tax settings for this phase.
|
|
1272
638
|
attr_accessor :automatic_tax
|
|
1273
|
-
# Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/
|
|
639
|
+
# Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
|
|
1274
640
|
attr_accessor :billing_cycle_anchor
|
|
1275
641
|
# 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.
|
|
1276
642
|
attr_accessor :billing_thresholds
|
|
@@ -1280,7 +646,7 @@ module Stripe
|
|
|
1280
646
|
attr_accessor :currency
|
|
1281
647
|
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
|
|
1282
648
|
attr_accessor :default_payment_method
|
|
1283
|
-
# A list of [Tax Rate](https://stripe.com/
|
|
649
|
+
# A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
|
|
1284
650
|
attr_accessor :default_tax_rates
|
|
1285
651
|
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
|
1286
652
|
attr_accessor :description
|
|
@@ -1288,19 +654,17 @@ module Stripe
|
|
|
1288
654
|
attr_accessor :discounts
|
|
1289
655
|
# The number of intervals the phase should last. If set, `end_date` must not be set.
|
|
1290
656
|
attr_accessor :duration
|
|
1291
|
-
# The date at which this phase of the subscription schedule ends. If set, `
|
|
657
|
+
# The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.
|
|
1292
658
|
attr_accessor :end_date
|
|
1293
659
|
# All invoices will be billed using the specified settings.
|
|
1294
660
|
attr_accessor :invoice_settings
|
|
1295
661
|
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
|
|
1296
662
|
attr_accessor :items
|
|
1297
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
663
|
+
# Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
|
|
1298
664
|
attr_accessor :metadata
|
|
1299
665
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
|
1300
666
|
attr_accessor :on_behalf_of
|
|
1301
|
-
#
|
|
1302
|
-
attr_accessor :pause_collection
|
|
1303
|
-
# 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.
|
|
667
|
+
# Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
|
|
1304
668
|
attr_accessor :proration_behavior
|
|
1305
669
|
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
|
|
1306
670
|
attr_accessor :start_date
|
|
@@ -1308,12 +672,8 @@ module Stripe
|
|
|
1308
672
|
attr_accessor :transfer_data
|
|
1309
673
|
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
1310
674
|
attr_accessor :trial
|
|
1311
|
-
# Specify trial behavior when crossing phase boundaries
|
|
1312
|
-
attr_accessor :trial_continuation
|
|
1313
675
|
# 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`
|
|
1314
676
|
attr_accessor :trial_end
|
|
1315
|
-
# Settings related to subscription trials.
|
|
1316
|
-
attr_accessor :trial_settings
|
|
1317
677
|
|
|
1318
678
|
def initialize(
|
|
1319
679
|
add_invoice_items: nil,
|
|
@@ -1333,14 +693,11 @@ module Stripe
|
|
|
1333
693
|
items: nil,
|
|
1334
694
|
metadata: nil,
|
|
1335
695
|
on_behalf_of: nil,
|
|
1336
|
-
pause_collection: nil,
|
|
1337
696
|
proration_behavior: nil,
|
|
1338
697
|
start_date: nil,
|
|
1339
698
|
transfer_data: nil,
|
|
1340
699
|
trial: nil,
|
|
1341
|
-
|
|
1342
|
-
trial_end: nil,
|
|
1343
|
-
trial_settings: nil
|
|
700
|
+
trial_end: nil
|
|
1344
701
|
)
|
|
1345
702
|
@add_invoice_items = add_invoice_items
|
|
1346
703
|
@application_fee_percent = application_fee_percent
|
|
@@ -1359,95 +716,26 @@ module Stripe
|
|
|
1359
716
|
@items = items
|
|
1360
717
|
@metadata = metadata
|
|
1361
718
|
@on_behalf_of = on_behalf_of
|
|
1362
|
-
@pause_collection = pause_collection
|
|
1363
719
|
@proration_behavior = proration_behavior
|
|
1364
720
|
@start_date = start_date
|
|
1365
721
|
@transfer_data = transfer_data
|
|
1366
722
|
@trial = trial
|
|
1367
|
-
@trial_continuation = trial_continuation
|
|
1368
723
|
@trial_end = trial_end
|
|
1369
|
-
@trial_settings = trial_settings
|
|
1370
724
|
end
|
|
1371
725
|
end
|
|
1372
|
-
|
|
1373
|
-
class Prebilling < ::Stripe::RequestParams
|
|
1374
|
-
class BillUntil < ::Stripe::RequestParams
|
|
1375
|
-
class AmendmentEnd < ::Stripe::RequestParams
|
|
1376
|
-
# The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.
|
|
1377
|
-
attr_accessor :index
|
|
1378
|
-
|
|
1379
|
-
def initialize(index: nil)
|
|
1380
|
-
@index = index
|
|
1381
|
-
end
|
|
1382
|
-
end
|
|
1383
|
-
|
|
1384
|
-
class Duration < ::Stripe::RequestParams
|
|
1385
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1386
|
-
attr_accessor :interval
|
|
1387
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1388
|
-
attr_accessor :interval_count
|
|
1389
|
-
|
|
1390
|
-
def initialize(interval: nil, interval_count: nil)
|
|
1391
|
-
@interval = interval
|
|
1392
|
-
@interval_count = interval_count
|
|
1393
|
-
end
|
|
1394
|
-
end
|
|
1395
|
-
# End the prebilled period when a specified amendment ends.
|
|
1396
|
-
attr_accessor :amendment_end
|
|
1397
|
-
# Time span for prebilling, starting from `bill_from`.
|
|
1398
|
-
attr_accessor :duration
|
|
1399
|
-
# End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
|
1400
|
-
attr_accessor :timestamp
|
|
1401
|
-
# Select one of several ways to pass the `bill_until` value.
|
|
1402
|
-
attr_accessor :type
|
|
1403
|
-
|
|
1404
|
-
def initialize(amendment_end: nil, duration: nil, timestamp: nil, type: nil)
|
|
1405
|
-
@amendment_end = amendment_end
|
|
1406
|
-
@duration = duration
|
|
1407
|
-
@timestamp = timestamp
|
|
1408
|
-
@type = type
|
|
1409
|
-
end
|
|
1410
|
-
end
|
|
1411
|
-
# The end of the prebilled time period.
|
|
1412
|
-
attr_accessor :bill_until
|
|
1413
|
-
# This is used to determine the number of billing cycles to prebill.
|
|
1414
|
-
attr_accessor :iterations
|
|
1415
|
-
|
|
1416
|
-
def initialize(bill_until: nil, iterations: nil)
|
|
1417
|
-
@bill_until = bill_until
|
|
1418
|
-
@iterations = iterations
|
|
1419
|
-
end
|
|
1420
|
-
end
|
|
1421
|
-
# Changes to apply to the phases of the subscription schedule, in the order provided.
|
|
1422
|
-
attr_accessor :amendments
|
|
1423
|
-
# 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.
|
|
1424
|
-
attr_accessor :billing_behavior
|
|
1425
726
|
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
1426
727
|
attr_accessor :billing_mode
|
|
1427
728
|
# 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.
|
|
1428
729
|
attr_accessor :end_behavior
|
|
1429
730
|
# 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.
|
|
1430
731
|
attr_accessor :phases
|
|
1431
|
-
# Provide any time periods to bill in advance.
|
|
1432
|
-
attr_accessor :prebilling
|
|
1433
732
|
# In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
|
|
1434
733
|
attr_accessor :proration_behavior
|
|
1435
734
|
|
|
1436
|
-
def initialize(
|
|
1437
|
-
amendments: nil,
|
|
1438
|
-
billing_behavior: nil,
|
|
1439
|
-
billing_mode: nil,
|
|
1440
|
-
end_behavior: nil,
|
|
1441
|
-
phases: nil,
|
|
1442
|
-
prebilling: nil,
|
|
1443
|
-
proration_behavior: nil
|
|
1444
|
-
)
|
|
1445
|
-
@amendments = amendments
|
|
1446
|
-
@billing_behavior = billing_behavior
|
|
735
|
+
def initialize(billing_mode: nil, end_behavior: nil, phases: nil, proration_behavior: nil)
|
|
1447
736
|
@billing_mode = billing_mode
|
|
1448
737
|
@end_behavior = end_behavior
|
|
1449
738
|
@phases = phases
|
|
1450
|
-
@prebilling = prebilling
|
|
1451
739
|
@proration_behavior = proration_behavior
|
|
1452
740
|
end
|
|
1453
741
|
end
|
|
@@ -1473,61 +761,9 @@ module Stripe
|
|
|
1473
761
|
end
|
|
1474
762
|
end
|
|
1475
763
|
|
|
1476
|
-
class BillingSchedule < ::Stripe::RequestParams
|
|
1477
|
-
class AppliesTo < ::Stripe::RequestParams
|
|
1478
|
-
# The ID of the price object.
|
|
1479
|
-
attr_accessor :price
|
|
1480
|
-
# Controls which subscription items the billing schedule applies to.
|
|
1481
|
-
attr_accessor :type
|
|
1482
|
-
|
|
1483
|
-
def initialize(price: nil, type: nil)
|
|
1484
|
-
@price = price
|
|
1485
|
-
@type = type
|
|
1486
|
-
end
|
|
1487
|
-
end
|
|
1488
|
-
|
|
1489
|
-
class BillUntil < ::Stripe::RequestParams
|
|
1490
|
-
class Duration < ::Stripe::RequestParams
|
|
1491
|
-
# Specifies billing duration. Either `day`, `week`, `month` or `year`.
|
|
1492
|
-
attr_accessor :interval
|
|
1493
|
-
# The multiplier applied to the interval.
|
|
1494
|
-
attr_accessor :interval_count
|
|
1495
|
-
|
|
1496
|
-
def initialize(interval: nil, interval_count: nil)
|
|
1497
|
-
@interval = interval
|
|
1498
|
-
@interval_count = interval_count
|
|
1499
|
-
end
|
|
1500
|
-
end
|
|
1501
|
-
# Specifies the billing period.
|
|
1502
|
-
attr_accessor :duration
|
|
1503
|
-
# The end date of the billing schedule.
|
|
1504
|
-
attr_accessor :timestamp
|
|
1505
|
-
# Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
|
|
1506
|
-
attr_accessor :type
|
|
1507
|
-
|
|
1508
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
|
1509
|
-
@duration = duration
|
|
1510
|
-
@timestamp = timestamp
|
|
1511
|
-
@type = type
|
|
1512
|
-
end
|
|
1513
|
-
end
|
|
1514
|
-
# Configure billing schedule differently for individual subscription items.
|
|
1515
|
-
attr_accessor :applies_to
|
|
1516
|
-
# The end date for the billing schedule.
|
|
1517
|
-
attr_accessor :bill_until
|
|
1518
|
-
# Specify a key for the billing schedule. Must be unique to this field, alphanumeric, and up to 200 characters. If not provided, a unique key will be generated.
|
|
1519
|
-
attr_accessor :key
|
|
1520
|
-
|
|
1521
|
-
def initialize(applies_to: nil, bill_until: nil, key: nil)
|
|
1522
|
-
@applies_to = applies_to
|
|
1523
|
-
@bill_until = bill_until
|
|
1524
|
-
@key = key
|
|
1525
|
-
end
|
|
1526
|
-
end
|
|
1527
|
-
|
|
1528
764
|
class Item < ::Stripe::RequestParams
|
|
1529
765
|
class BillingThresholds < ::Stripe::RequestParams
|
|
1530
|
-
# Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/
|
|
766
|
+
# Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
|
1531
767
|
attr_accessor :usage_gte
|
|
1532
768
|
|
|
1533
769
|
def initialize(usage_gte: nil)
|
|
@@ -1536,44 +772,16 @@ module Stripe
|
|
|
1536
772
|
end
|
|
1537
773
|
|
|
1538
774
|
class Discount < ::Stripe::RequestParams
|
|
1539
|
-
class DiscountEnd < ::Stripe::RequestParams
|
|
1540
|
-
class Duration < ::Stripe::RequestParams
|
|
1541
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
|
1542
|
-
attr_accessor :interval
|
|
1543
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
|
1544
|
-
attr_accessor :interval_count
|
|
1545
|
-
|
|
1546
|
-
def initialize(interval: nil, interval_count: nil)
|
|
1547
|
-
@interval = interval
|
|
1548
|
-
@interval_count = interval_count
|
|
1549
|
-
end
|
|
1550
|
-
end
|
|
1551
|
-
# Time span for the redeemed discount.
|
|
1552
|
-
attr_accessor :duration
|
|
1553
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
|
1554
|
-
attr_accessor :timestamp
|
|
1555
|
-
# The type of calculation made to determine when the discount ends.
|
|
1556
|
-
attr_accessor :type
|
|
1557
|
-
|
|
1558
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
|
1559
|
-
@duration = duration
|
|
1560
|
-
@timestamp = timestamp
|
|
1561
|
-
@type = type
|
|
1562
|
-
end
|
|
1563
|
-
end
|
|
1564
775
|
# ID of the coupon to create a new discount for.
|
|
1565
776
|
attr_accessor :coupon
|
|
1566
777
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
|
1567
778
|
attr_accessor :discount
|
|
1568
|
-
# Details to determine how long the discount should be applied for.
|
|
1569
|
-
attr_accessor :discount_end
|
|
1570
779
|
# ID of the promotion code to create a new discount for.
|
|
1571
780
|
attr_accessor :promotion_code
|
|
1572
781
|
|
|
1573
|
-
def initialize(coupon: nil, discount: nil,
|
|
782
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
|
1574
783
|
@coupon = coupon
|
|
1575
784
|
@discount = discount
|
|
1576
|
-
@discount_end = discount_end
|
|
1577
785
|
@promotion_code = promotion_code
|
|
1578
786
|
end
|
|
1579
787
|
end
|
|
@@ -1596,7 +804,7 @@ module Stripe
|
|
|
1596
804
|
attr_accessor :product
|
|
1597
805
|
# The recurring components of a price such as `interval` and `interval_count`.
|
|
1598
806
|
attr_accessor :recurring
|
|
1599
|
-
# Only required if a [default tax behavior](https://stripe.com/
|
|
807
|
+
# 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.
|
|
1600
808
|
attr_accessor :tax_behavior
|
|
1601
809
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
|
1602
810
|
attr_accessor :unit_amount
|
|
@@ -1629,17 +837,17 @@ module Stripe
|
|
|
1629
837
|
attr_accessor :discounts
|
|
1630
838
|
# Subscription item to update.
|
|
1631
839
|
attr_accessor :id
|
|
1632
|
-
# Set of [key-value pairs](https://stripe.com/
|
|
840
|
+
# 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`.
|
|
1633
841
|
attr_accessor :metadata
|
|
1634
842
|
# Plan ID for this item, as a string.
|
|
1635
843
|
attr_accessor :plan
|
|
1636
844
|
# The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
|
|
1637
845
|
attr_accessor :price
|
|
1638
|
-
# Data used to generate a new [Price](https://stripe.com/
|
|
846
|
+
# Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
|
|
1639
847
|
attr_accessor :price_data
|
|
1640
848
|
# Quantity for this item.
|
|
1641
849
|
attr_accessor :quantity
|
|
1642
|
-
# A list of [Tax Rate](https://stripe.com/
|
|
850
|
+
# A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
|
1643
851
|
attr_accessor :tax_rates
|
|
1644
852
|
|
|
1645
853
|
def initialize(
|
|
@@ -1668,21 +876,10 @@ module Stripe
|
|
|
1668
876
|
@tax_rates = tax_rates
|
|
1669
877
|
end
|
|
1670
878
|
end
|
|
1671
|
-
|
|
1672
|
-
class Prebilling < ::Stripe::RequestParams
|
|
1673
|
-
# This is used to determine the number of billing cycles to prebill.
|
|
1674
|
-
attr_accessor :iterations
|
|
1675
|
-
|
|
1676
|
-
def initialize(iterations: nil)
|
|
1677
|
-
@iterations = iterations
|
|
1678
|
-
end
|
|
1679
|
-
end
|
|
1680
|
-
# For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
|
|
879
|
+
# For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
|
|
1681
880
|
attr_accessor :billing_cycle_anchor
|
|
1682
881
|
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
1683
882
|
attr_accessor :billing_mode
|
|
1684
|
-
# Sets the billing schedules for the subscription.
|
|
1685
|
-
attr_accessor :billing_schedules
|
|
1686
883
|
# A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
|
|
1687
884
|
attr_accessor :cancel_at
|
|
1688
885
|
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
|
|
@@ -1693,9 +890,7 @@ module Stripe
|
|
|
1693
890
|
attr_accessor :default_tax_rates
|
|
1694
891
|
# A list of up to 20 subscription items, each with an attached price.
|
|
1695
892
|
attr_accessor :items
|
|
1696
|
-
#
|
|
1697
|
-
attr_accessor :prebilling
|
|
1698
|
-
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
|
|
893
|
+
# Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
|
|
1699
894
|
attr_accessor :proration_behavior
|
|
1700
895
|
# If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.
|
|
1701
896
|
attr_accessor :proration_date
|
|
@@ -1709,13 +904,11 @@ module Stripe
|
|
|
1709
904
|
def initialize(
|
|
1710
905
|
billing_cycle_anchor: nil,
|
|
1711
906
|
billing_mode: nil,
|
|
1712
|
-
billing_schedules: nil,
|
|
1713
907
|
cancel_at: nil,
|
|
1714
908
|
cancel_at_period_end: nil,
|
|
1715
909
|
cancel_now: nil,
|
|
1716
910
|
default_tax_rates: nil,
|
|
1717
911
|
items: nil,
|
|
1718
|
-
prebilling: nil,
|
|
1719
912
|
proration_behavior: nil,
|
|
1720
913
|
proration_date: nil,
|
|
1721
914
|
resume_at: nil,
|
|
@@ -1724,13 +917,11 @@ module Stripe
|
|
|
1724
917
|
)
|
|
1725
918
|
@billing_cycle_anchor = billing_cycle_anchor
|
|
1726
919
|
@billing_mode = billing_mode
|
|
1727
|
-
@billing_schedules = billing_schedules
|
|
1728
920
|
@cancel_at = cancel_at
|
|
1729
921
|
@cancel_at_period_end = cancel_at_period_end
|
|
1730
922
|
@cancel_now = cancel_now
|
|
1731
923
|
@default_tax_rates = default_tax_rates
|
|
1732
924
|
@items = items
|
|
1733
|
-
@prebilling = prebilling
|
|
1734
925
|
@proration_behavior = proration_behavior
|
|
1735
926
|
@proration_date = proration_date
|
|
1736
927
|
@resume_at = resume_at
|
|
@@ -1740,13 +931,11 @@ module Stripe
|
|
|
1740
931
|
end
|
|
1741
932
|
# Settings for automatic tax lookup for this invoice preview.
|
|
1742
933
|
attr_accessor :automatic_tax
|
|
1743
|
-
# The identifier of the billing cadence for which you’d like to retrieve the upcoming invoice.Cannot be provided when `subscription`, `schedule`, `subscription_details` or `schedule_details` are provided.
|
|
1744
|
-
attr_accessor :billing_cadence
|
|
1745
934
|
# The currency to preview this invoice in. Defaults to that of `customer` if not specified.
|
|
1746
935
|
attr_accessor :currency
|
|
1747
|
-
# The identifier of the customer whose upcoming invoice you'
|
|
936
|
+
# The identifier of the customer whose upcoming invoice you're retrieving. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
|
|
1748
937
|
attr_accessor :customer
|
|
1749
|
-
# The identifier of the account whose upcoming invoice you'
|
|
938
|
+
# The identifier of the account representing the customer whose upcoming invoice you're retrieving. If `automatic_tax` is enabled then one of `customer`, `customer_account`, `customer_details`, `subscription`, or `schedule` must be set.
|
|
1750
939
|
attr_accessor :customer_account
|
|
1751
940
|
# Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
|
|
1752
941
|
attr_accessor :customer_details
|
|
@@ -1758,7 +947,7 @@ module Stripe
|
|
|
1758
947
|
attr_accessor :invoice_items
|
|
1759
948
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
|
1760
949
|
attr_accessor :issuer
|
|
1761
|
-
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/
|
|
950
|
+
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details.
|
|
1762
951
|
attr_accessor :on_behalf_of
|
|
1763
952
|
# Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.
|
|
1764
953
|
attr_accessor :preview_mode
|
|
@@ -1773,7 +962,6 @@ module Stripe
|
|
|
1773
962
|
|
|
1774
963
|
def initialize(
|
|
1775
964
|
automatic_tax: nil,
|
|
1776
|
-
billing_cadence: nil,
|
|
1777
965
|
currency: nil,
|
|
1778
966
|
customer: nil,
|
|
1779
967
|
customer_account: nil,
|
|
@@ -1790,7 +978,6 @@ module Stripe
|
|
|
1790
978
|
subscription_details: nil
|
|
1791
979
|
)
|
|
1792
980
|
@automatic_tax = automatic_tax
|
|
1793
|
-
@billing_cadence = billing_cadence
|
|
1794
981
|
@currency = currency
|
|
1795
982
|
@customer = customer
|
|
1796
983
|
@customer_account = customer_account
|