stripe 13.4.0.pre.beta.1 → 13.4.0.pre.beta.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -1
- data/OPENAPI_VERSION +1 -1
- data/VERSION +1 -1
- data/lib/stripe/resources/account.rb +23 -745
- data/lib/stripe/resources/account_link.rb +0 -10
- data/lib/stripe/resources/account_notice.rb +0 -22
- data/lib/stripe/resources/account_session.rb +0 -125
- data/lib/stripe/resources/apple_pay_domain.rb +0 -10
- data/lib/stripe/resources/application.rb +0 -3
- data/lib/stripe/resources/application_fee.rb +0 -24
- data/lib/stripe/resources/application_fee_refund.rb +0 -7
- data/lib/stripe/resources/apps/secret.rb +0 -25
- data/lib/stripe/resources/balance.rb +0 -31
- data/lib/stripe/resources/balance_transaction.rb +0 -29
- data/lib/stripe/resources/bank_account.rb +0 -29
- data/lib/stripe/resources/billing/alert.rb +0 -22
- data/lib/stripe/resources/billing/alert_triggered.rb +0 -5
- data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -12
- data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -24
- data/lib/stripe/resources/billing/credit_grant.rb +0 -32
- data/lib/stripe/resources/billing/meter.rb +0 -25
- data/lib/stripe/resources/billing/meter_error_report.rb +0 -11
- data/lib/stripe/resources/billing/meter_event.rb +0 -10
- data/lib/stripe/resources/billing/meter_event_adjustment.rb +0 -8
- data/lib/stripe/resources/billing/meter_event_summary.rb +0 -6
- data/lib/stripe/resources/billing_portal/configuration.rb +0 -77
- data/lib/stripe/resources/billing_portal/session.rb +0 -42
- data/lib/stripe/resources/capability.rb +2 -29
- data/lib/stripe/resources/capital/financing_offer.rb +0 -33
- data/lib/stripe/resources/capital/financing_summary.rb +0 -13
- data/lib/stripe/resources/capital/financing_transaction.rb +0 -24
- data/lib/stripe/resources/card.rb +2 -34
- data/lib/stripe/resources/cash_balance.rb +0 -5
- data/lib/stripe/resources/charge.rb +4 -665
- data/lib/stripe/resources/checkout/session.rb +4 -512
- data/lib/stripe/resources/climate/order.rb +0 -40
- data/lib/stripe/resources/climate/product.rb +0 -13
- data/lib/stripe/resources/climate/supplier.rb +0 -13
- data/lib/stripe/resources/confirmation_token.rb +2 -337
- data/lib/stripe/resources/connect_collection_transfer.rb +0 -5
- data/lib/stripe/resources/country_spec.rb +0 -13
- data/lib/stripe/resources/coupon.rb +0 -39
- data/lib/stripe/resources/credit_note.rb +0 -138
- data/lib/stripe/resources/credit_note_line_item.rb +0 -24
- data/lib/stripe/resources/customer.rb +1 -156
- data/lib/stripe/resources/customer_balance_transaction.rb +0 -12
- data/lib/stripe/resources/customer_cash_balance_transaction.rb +0 -27
- data/lib/stripe/resources/customer_session.rb +0 -24
- data/lib/stripe/resources/discount.rb +0 -12
- data/lib/stripe/resources/dispute.rb +4 -152
- data/lib/stripe/resources/entitlements/active_entitlement.rb +0 -8
- data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +0 -3
- data/lib/stripe/resources/entitlements/feature.rb +0 -17
- data/lib/stripe/resources/ephemeral_key.rb +0 -5
- data/lib/stripe/resources/event.rb +0 -27
- data/lib/stripe/resources/exchange_rate.rb +0 -5
- data/lib/stripe/resources/file.rb +0 -23
- data/lib/stripe/resources/file_link.rb +0 -22
- data/lib/stripe/resources/financial_connections/account.rb +0 -47
- data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -3
- data/lib/stripe/resources/financial_connections/account_owner.rb +0 -7
- data/lib/stripe/resources/financial_connections/account_ownership.rb +0 -3
- data/lib/stripe/resources/financial_connections/institution.rb +0 -13
- data/lib/stripe/resources/financial_connections/session.rb +0 -28
- data/lib/stripe/resources/financial_connections/transaction.rb +0 -21
- data/lib/stripe/resources/forwarding/request.rb +0 -31
- data/lib/stripe/resources/funding_instructions.rb +0 -107
- data/lib/stripe/resources/gift_cards/card.rb +0 -28
- data/lib/stripe/resources/gift_cards/transaction.rb +0 -32
- data/lib/stripe/resources/identity/verification_report.rb +0 -69
- data/lib/stripe/resources/identity/verification_session.rb +0 -69
- data/lib/stripe/resources/invoice.rb +6 -1276
- data/lib/stripe/resources/invoice_item.rb +0 -91
- data/lib/stripe/resources/invoice_line_item.rb +0 -76
- data/lib/stripe/resources/invoice_payment.rb +0 -16
- data/lib/stripe/resources/invoice_rendering_template.rb +0 -12
- data/lib/stripe/resources/issuing/authorization.rb +0 -199
- data/lib/stripe/resources/issuing/card.rb +0 -128
- data/lib/stripe/resources/issuing/cardholder.rb +0 -110
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -82
- data/lib/stripe/resources/issuing/dispute.rb +0 -151
- data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -14
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -14
- data/lib/stripe/resources/issuing/personalization_design.rb +0 -48
- data/lib/stripe/resources/issuing/physical_bundle.rb +0 -13
- data/lib/stripe/resources/issuing/settlement.rb +0 -16
- data/lib/stripe/resources/issuing/token.rb +0 -46
- data/lib/stripe/resources/issuing/transaction.rb +0 -171
- data/lib/stripe/resources/line_item.rb +0 -23
- data/lib/stripe/resources/login_link.rb +0 -2
- data/lib/stripe/resources/mandate.rb +0 -45
- data/lib/stripe/resources/margin.rb +0 -19
- data/lib/stripe/resources/order.rb +3 -391
- data/lib/stripe/resources/payment_attempt_record.rb +0 -42
- data/lib/stripe/resources/payment_intent.rb +2 -1768
- data/lib/stripe/resources/payment_link.rb +15 -213
- data/lib/stripe/resources/payment_method.rb +2 -345
- data/lib/stripe/resources/payment_method_configuration.rb +0 -293
- data/lib/stripe/resources/payment_method_domain.rb +0 -23
- data/lib/stripe/resources/payment_record.rb +0 -109
- data/lib/stripe/resources/payout.rb +0 -49
- data/lib/stripe/resources/person.rb +2 -92
- data/lib/stripe/resources/plan.rb +0 -69
- data/lib/stripe/resources/price.rb +0 -133
- data/lib/stripe/resources/product.rb +0 -100
- data/lib/stripe/resources/product_feature.rb +0 -4
- data/lib/stripe/resources/promotion_code.rb +0 -40
- data/lib/stripe/resources/quote.rb +0 -458
- data/lib/stripe/resources/quote_line.rb +0 -66
- data/lib/stripe/resources/quote_preview_invoice.rb +3 -184
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -101
- data/lib/stripe/resources/radar/early_fraud_warning.rb +0 -16
- data/lib/stripe/resources/radar/value_list.rb +0 -26
- data/lib/stripe/resources/radar/value_list_item.rb +0 -18
- data/lib/stripe/resources/refund.rb +0 -92
- data/lib/stripe/resources/reporting/report_run.rb +0 -32
- data/lib/stripe/resources/reporting/report_type.rb +0 -8
- data/lib/stripe/resources/reserve_transaction.rb +0 -4
- data/lib/stripe/resources/reversal.rb +0 -9
- data/lib/stripe/resources/review.rb +0 -27
- data/lib/stripe/resources/setup_attempt.rb +2 -103
- data/lib/stripe/resources/setup_intent.rb +2 -539
- data/lib/stripe/resources/shipping_rate.rb +0 -44
- data/lib/stripe/resources/sigma/scheduled_query_run.rb +0 -13
- data/lib/stripe/resources/source.rb +6 -338
- data/lib/stripe/resources/source_mandate_notification.rb +0 -13
- data/lib/stripe/resources/source_transaction.rb +0 -29
- data/lib/stripe/resources/subscription.rb +0 -338
- data/lib/stripe/resources/subscription_item.rb +0 -69
- data/lib/stripe/resources/subscription_schedule.rb +0 -388
- data/lib/stripe/resources/tax/association.rb +0 -11
- data/lib/stripe/resources/tax/calculation.rb +2 -89
- data/lib/stripe/resources/tax/calculation_line_item.rb +0 -20
- data/lib/stripe/resources/tax/form.rb +2 -35
- data/lib/stripe/resources/tax/registration.rb +421 -213
- data/lib/stripe/resources/tax/settings.rb +0 -20
- data/lib/stripe/resources/tax/transaction.rb +1 -66
- data/lib/stripe/resources/tax/transaction_line_item.rb +0 -12
- data/lib/stripe/resources/tax_code.rb +0 -6
- data/lib/stripe/resources/tax_deducted_at_source.rb +0 -4
- data/lib/stripe/resources/tax_id.rb +2 -28
- data/lib/stripe/resources/tax_rate.rb +0 -45
- data/lib/stripe/resources/terminal/configuration.rb +0 -164
- data/lib/stripe/resources/terminal/connection_token.rb +0 -3
- data/lib/stripe/resources/terminal/location.rb +0 -33
- data/lib/stripe/resources/terminal/reader.rb +0 -129
- data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -5
- data/lib/stripe/resources/test_helpers/test_clock.rb +0 -15
- data/lib/stripe/resources/token.rb +4 -192
- data/lib/stripe/resources/topup.rb +0 -36
- data/lib/stripe/resources/transfer.rb +0 -35
- data/lib/stripe/resources/treasury/credit_reversal.rb +0 -21
- data/lib/stripe/resources/treasury/debit_reversal.rb +0 -23
- data/lib/stripe/resources/treasury/financial_account.rb +77 -71
- data/lib/stripe/resources/treasury/financial_account_features.rb +0 -46
- data/lib/stripe/resources/treasury/inbound_transfer.rb +0 -50
- data/lib/stripe/resources/treasury/outbound_payment.rb +0 -92
- data/lib/stripe/resources/treasury/outbound_transfer.rb +25 -66
- data/lib/stripe/resources/treasury/received_credit.rb +6 -58
- data/lib/stripe/resources/treasury/received_debit.rb +0 -54
- data/lib/stripe/resources/treasury/transaction.rb +0 -39
- data/lib/stripe/resources/treasury/transaction_entry.rb +0 -36
- data/lib/stripe/resources/usage_record.rb +0 -5
- data/lib/stripe/resources/usage_record_summary.rb +0 -7
- data/lib/stripe/resources/v2/billing/meter_event.rb +0 -6
- data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +0 -7
- data/lib/stripe/resources/v2/billing/meter_event_session.rb +0 -5
- data/lib/stripe/resources/v2/event.rb +0 -8
- data/lib/stripe/resources/v2/event_destination.rb +0 -19
- data/lib/stripe/resources/webhook_endpoint.rb +0 -26
- data/lib/stripe/services/account_capability_service.rb +0 -1
- data/lib/stripe/services/account_external_account_service.rb +0 -43
- data/lib/stripe/services/account_link_service.rb +0 -7
- data/lib/stripe/services/account_notice_service.rb +0 -9
- data/lib/stripe/services/account_person_service.rb +0 -139
- data/lib/stripe/services/account_service.rb +8 -519
- data/lib/stripe/services/account_session_service.rb +0 -76
- data/lib/stripe/services/apple_pay_domain_service.rb +0 -5
- data/lib/stripe/services/application_fee_refund_service.rb +0 -6
- data/lib/stripe/services/application_fee_service.rb +0 -8
- data/lib/stripe/services/apps/secret_service.rb +0 -16
- data/lib/stripe/services/balance_transaction_service.rb +0 -11
- data/lib/stripe/services/billing/alert_service.rb +0 -12
- data/lib/stripe/services/billing/credit_balance_summary_service.rb +0 -4
- data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -5
- data/lib/stripe/services/billing/credit_grant_service.rb +0 -16
- data/lib/stripe/services/billing/meter_event_adjustment_service.rb +0 -3
- data/lib/stripe/services/billing/meter_event_service.rb +0 -4
- data/lib/stripe/services/billing/meter_event_summary_service.rb +0 -7
- data/lib/stripe/services/billing/meter_service.rb +0 -12
- data/lib/stripe/services/billing_portal/configuration_service.rb +0 -48
- data/lib/stripe/services/billing_portal/session_service.rb +0 -19
- data/lib/stripe/services/capital/financing_offer_service.rb +0 -9
- data/lib/stripe/services/capital/financing_transaction_service.rb +0 -7
- data/lib/stripe/services/charge_service.rb +0 -274
- data/lib/stripe/services/checkout/session_line_item_service.rb +0 -3
- data/lib/stripe/services/checkout/session_service.rb +2 -273
- data/lib/stripe/services/climate/order_service.rb +0 -11
- data/lib/stripe/services/climate/product_service.rb +0 -3
- data/lib/stripe/services/climate/supplier_service.rb +0 -3
- data/lib/stripe/services/country_spec_service.rb +0 -3
- data/lib/stripe/services/coupon_service.rb +0 -22
- data/lib/stripe/services/credit_note_line_item_service.rb +0 -3
- data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -28
- data/lib/stripe/services/credit_note_service.rb +0 -61
- data/lib/stripe/services/customer_balance_transaction_service.rb +0 -9
- data/lib/stripe/services/customer_cash_balance_service.rb +0 -1
- data/lib/stripe/services/customer_cash_balance_transaction_service.rb +0 -3
- data/lib/stripe/services/customer_funding_instructions_service.rb +0 -5
- data/lib/stripe/services/customer_payment_method_service.rb +0 -5
- data/lib/stripe/services/customer_payment_source_service.rb +0 -29
- data/lib/stripe/services/customer_service.rb +1 -92
- data/lib/stripe/services/customer_session_service.rb +0 -10
- data/lib/stripe/services/customer_tax_id_service.rb +1 -6
- data/lib/stripe/services/dispute_service.rb +2 -67
- data/lib/stripe/services/entitlements/active_entitlement_service.rb +0 -4
- data/lib/stripe/services/entitlements/feature_service.rb +0 -11
- data/lib/stripe/services/ephemeral_key_service.rb +0 -4
- data/lib/stripe/services/event_service.rb +0 -10
- data/lib/stripe/services/exchange_rate_service.rb +0 -3
- data/lib/stripe/services/file_link_service.rb +0 -14
- data/lib/stripe/services/file_service.rb +0 -13
- data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -3
- data/lib/stripe/services/financial_connections/account_owner_service.rb +0 -4
- data/lib/stripe/services/financial_connections/account_service.rb +0 -9
- data/lib/stripe/services/financial_connections/institution_service.rb +0 -3
- data/lib/stripe/services/financial_connections/session_service.rb +0 -11
- data/lib/stripe/services/financial_connections/transaction_service.rb +0 -9
- data/lib/stripe/services/forwarding/request_service.rb +0 -14
- data/lib/stripe/services/gift_cards/card_service.rb +0 -13
- data/lib/stripe/services/gift_cards/transaction_service.rb +0 -16
- data/lib/stripe/services/identity/verification_report_service.rb +0 -10
- data/lib/stripe/services/identity/verification_session_service.rb +0 -30
- data/lib/stripe/services/invoice_item_service.rb +0 -66
- data/lib/stripe/services/invoice_line_item_service.rb +0 -40
- data/lib/stripe/services/invoice_payment_service.rb +0 -3
- data/lib/stripe/services/invoice_rendering_template_service.rb +0 -5
- data/lib/stripe/services/invoice_service.rb +2 -810
- data/lib/stripe/services/invoice_upcoming_lines_service.rb +1 -279
- data/lib/stripe/services/issuing/authorization_service.rb +0 -14
- data/lib/stripe/services/issuing/card_service.rb +0 -70
- data/lib/stripe/services/issuing/cardholder_service.rb +0 -73
- data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -56
- data/lib/stripe/services/issuing/dispute_service.rb +0 -98
- data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -4
- data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -7
- data/lib/stripe/services/issuing/personalization_design_service.rb +0 -29
- data/lib/stripe/services/issuing/physical_bundle_service.rb +0 -5
- data/lib/stripe/services/issuing/token_service.rb +0 -10
- data/lib/stripe/services/issuing/transaction_service.rb +0 -12
- data/lib/stripe/services/margin_service.rb +0 -11
- data/lib/stripe/services/order_line_item_service.rb +0 -3
- data/lib/stripe/services/order_service.rb +2 -266
- data/lib/stripe/services/payment_attempt_record_service.rb +0 -1
- data/lib/stripe/services/payment_intent_service.rb +0 -1309
- data/lib/stripe/services/payment_link_line_item_service.rb +0 -3
- data/lib/stripe/services/payment_link_service.rb +15 -135
- data/lib/stripe/services/payment_method_configuration_service.rb +0 -102
- data/lib/stripe/services/payment_method_domain_service.rb +0 -8
- data/lib/stripe/services/payment_method_service.rb +0 -113
- data/lib/stripe/services/payment_record_service.rb +0 -68
- data/lib/stripe/services/payout_service.rb +0 -23
- data/lib/stripe/services/plan_service.rb +0 -43
- data/lib/stripe/services/price_service.rb +0 -87
- data/lib/stripe/services/product_feature_service.rb +0 -4
- data/lib/stripe/services/product_service.rb +0 -74
- data/lib/stripe/services/promotion_code_service.rb +0 -25
- data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +0 -3
- data/lib/stripe/services/quote_line_item_service.rb +0 -3
- data/lib/stripe/services/quote_line_service.rb +0 -3
- data/lib/stripe/services/quote_preview_invoice_service.rb +0 -3
- data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -3
- data/lib/stripe/services/quote_service.rb +0 -309
- data/lib/stripe/services/radar/early_fraud_warning_service.rb +0 -9
- data/lib/stripe/services/radar/value_list_item_service.rb +0 -11
- data/lib/stripe/services/radar/value_list_service.rb +0 -16
- data/lib/stripe/services/refund_service.rb +0 -21
- data/lib/stripe/services/reporting/report_run_service.rb +0 -16
- data/lib/stripe/services/review_service.rb +0 -7
- data/lib/stripe/services/setup_attempt_service.rb +0 -8
- data/lib/stripe/services/setup_intent_service.rb +0 -447
- data/lib/stripe/services/shipping_rate_service.rb +0 -27
- data/lib/stripe/services/sigma/scheduled_query_run_service.rb +0 -3
- data/lib/stripe/services/source_service.rb +0 -92
- data/lib/stripe/services/source_transaction_service.rb +0 -3
- data/lib/stripe/services/subscription_item_service.rb +0 -56
- data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -3
- data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -3
- data/lib/stripe/services/subscription_schedule_service.rb +0 -290
- data/lib/stripe/services/subscription_service.rb +0 -245
- data/lib/stripe/services/tax/association_service.rb +0 -1
- data/lib/stripe/services/tax/calculation_line_item_service.rb +0 -3
- data/lib/stripe/services/tax/calculation_service.rb +1 -31
- data/lib/stripe/services/tax/form_service.rb +0 -7
- data/lib/stripe/services/tax/registration_service.rb +274 -108
- data/lib/stripe/services/tax/settings_service.rb +0 -8
- data/lib/stripe/services/tax/transaction_line_item_service.rb +0 -3
- data/lib/stripe/services/tax/transaction_service.rb +0 -17
- data/lib/stripe/services/tax_code_service.rb +0 -3
- data/lib/stripe/services/tax_id_service.rb +1 -12
- data/lib/stripe/services/tax_rate_service.rb +0 -27
- data/lib/stripe/services/terminal/configuration_service.rb +0 -108
- data/lib/stripe/services/terminal/connection_token_service.rb +0 -1
- data/lib/stripe/services/terminal/location_service.rb +0 -21
- data/lib/stripe/services/terminal/reader_service.rb +0 -53
- data/lib/stripe/services/test_helpers/confirmation_token_service.rb +0 -89
- data/lib/stripe/services/test_helpers/customer_service.rb +0 -3
- data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +0 -99
- data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +0 -2
- data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +0 -91
- data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -4
- data/lib/stripe/services/test_helpers/test_clock_service.rb +0 -6
- data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +0 -1
- data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +0 -6
- data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +0 -6
- data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +0 -11
- data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +0 -11
- data/lib/stripe/services/token_service.rb +4 -184
- data/lib/stripe/services/topup_service.rb +0 -21
- data/lib/stripe/services/transfer_reversal_service.rb +0 -8
- data/lib/stripe/services/transfer_service.rb +0 -19
- data/lib/stripe/services/treasury/credit_reversal_service.rb +0 -8
- data/lib/stripe/services/treasury/debit_reversal_service.rb +0 -9
- data/lib/stripe/services/treasury/financial_account_features_service.rb +0 -10
- data/lib/stripe/services/treasury/financial_account_service.rb +64 -36
- data/lib/stripe/services/treasury/inbound_transfer_service.rb +0 -12
- data/lib/stripe/services/treasury/outbound_payment_service.rb +0 -38
- data/lib/stripe/services/treasury/outbound_transfer_service.rb +16 -15
- data/lib/stripe/services/treasury/received_credit_service.rb +0 -6
- data/lib/stripe/services/treasury/received_debit_service.rb +0 -5
- data/lib/stripe/services/treasury/transaction_entry_service.rb +0 -14
- data/lib/stripe/services/treasury/transaction_service.rb +0 -14
- data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +0 -2
- data/lib/stripe/services/v2/billing/meter_event_service.rb +0 -3
- data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +0 -3
- data/lib/stripe/services/v2/core/event_destination_service.rb +0 -18
- data/lib/stripe/services/v2/core/event_service.rb +0 -2
- data/lib/stripe/services/webhook_endpoint_service.rb +0 -14
- data/lib/stripe/stripe_client.rb +1 -1
- data/lib/stripe/stripe_object.rb +3 -3
- data/lib/stripe/util.rb +1 -1
- data/lib/stripe/version.rb +1 -1
- data/rbi/stripe/resources/account.rbi +29 -1001
- data/rbi/stripe/resources/account_link.rbi +0 -13
- data/rbi/stripe/resources/account_notice.rbi +0 -27
- data/rbi/stripe/resources/account_session.rbi +0 -166
- data/rbi/stripe/resources/apple_pay_domain.rbi +0 -14
- data/rbi/stripe/resources/application.rbi +0 -3
- data/rbi/stripe/resources/application_fee.rbi +0 -28
- data/rbi/stripe/resources/application_fee_refund.rbi +0 -7
- data/rbi/stripe/resources/apps/secret.rbi +0 -34
- data/rbi/stripe/resources/balance.rbi +0 -33
- data/rbi/stripe/resources/balance_transaction.rbi +0 -33
- data/rbi/stripe/resources/bank_account.rbi +0 -29
- data/rbi/stripe/resources/billing/alert.rbi +0 -31
- data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -5
- data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -16
- data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -27
- data/rbi/stripe/resources/billing/credit_grant.rbi +0 -43
- data/rbi/stripe/resources/billing/meter.rbi +0 -35
- data/rbi/stripe/resources/billing/meter_error_report.rbi +0 -11
- data/rbi/stripe/resources/billing/meter_event.rbi +0 -12
- data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -11
- data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -6
- data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -106
- data/rbi/stripe/resources/billing_portal/session.rbi +0 -55
- data/rbi/stripe/resources/capability.rbi +2 -29
- data/rbi/stripe/resources/capital/financing_offer.rbi +0 -38
- data/rbi/stripe/resources/capital/financing_summary.rbi +0 -15
- data/rbi/stripe/resources/capital/financing_transaction.rbi +0 -27
- data/rbi/stripe/resources/card.rbi +3 -34
- data/rbi/stripe/resources/cash_balance.rbi +0 -5
- data/rbi/stripe/resources/charge.rbi +6 -738
- data/rbi/stripe/resources/checkout/session.rbi +4 -636
- data/rbi/stripe/resources/climate/order.rbi +0 -48
- data/rbi/stripe/resources/climate/product.rbi +0 -16
- data/rbi/stripe/resources/climate/supplier.rbi +0 -16
- data/rbi/stripe/resources/confirmation_token.rbi +3 -364
- data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -5
- data/rbi/stripe/resources/country_spec.rbi +0 -16
- data/rbi/stripe/resources/coupon.rbi +0 -48
- data/rbi/stripe/resources/credit_note.rbi +0 -159
- data/rbi/stripe/resources/credit_note_line_item.rbi +0 -24
- data/rbi/stripe/resources/customer.rbi +1 -188
- data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -12
- data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -27
- data/rbi/stripe/resources/customer_session.rbi +0 -31
- data/rbi/stripe/resources/discount.rbi +0 -12
- data/rbi/stripe/resources/dispute.rbi +4 -166
- data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -11
- data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -3
- data/rbi/stripe/resources/entitlements/feature.rbi +0 -22
- data/rbi/stripe/resources/ephemeral_key.rbi +0 -7
- data/rbi/stripe/resources/event.rbi +0 -31
- data/rbi/stripe/resources/exchange_rate.rbi +0 -8
- data/rbi/stripe/resources/file.rbi +0 -29
- data/rbi/stripe/resources/file_link.rbi +0 -28
- data/rbi/stripe/resources/financial_connections/account.rbi +0 -56
- data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +0 -3
- data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -7
- data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -3
- data/rbi/stripe/resources/financial_connections/institution.rbi +0 -16
- data/rbi/stripe/resources/financial_connections/session.rbi +0 -35
- data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -26
- data/rbi/stripe/resources/forwarding/request.rbi +0 -38
- data/rbi/stripe/resources/funding_instructions.rbi +0 -107
- data/rbi/stripe/resources/gift_cards/card.rbi +0 -36
- data/rbi/stripe/resources/gift_cards/transaction.rbi +0 -41
- data/rbi/stripe/resources/identity/verification_report.rbi +0 -73
- data/rbi/stripe/resources/identity/verification_session.rbi +0 -83
- data/rbi/stripe/resources/invoice.rbi +7 -1663
- data/rbi/stripe/resources/invoice_item.rbi +0 -107
- data/rbi/stripe/resources/invoice_line_item.rbi +0 -86
- data/rbi/stripe/resources/invoice_payment.rbi +0 -16
- data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -17
- data/rbi/stripe/resources/issuing/authorization.rbi +0 -245
- data/rbi/stripe/resources/issuing/card.rbi +0 -153
- data/rbi/stripe/resources/issuing/cardholder.rbi +0 -138
- data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +0 -109
- data/rbi/stripe/resources/issuing/dispute.rbi +0 -177
- data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +0 -17
- data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +0 -18
- data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -62
- data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -16
- data/rbi/stripe/resources/issuing/settlement.rbi +0 -16
- data/rbi/stripe/resources/issuing/token.rbi +0 -51
- data/rbi/stripe/resources/issuing/transaction.rbi +0 -205
- data/rbi/stripe/resources/line_item.rbi +0 -23
- data/rbi/stripe/resources/login_link.rbi +0 -2
- data/rbi/stripe/resources/mandate.rbi +0 -47
- data/rbi/stripe/resources/margin.rbi +0 -24
- data/rbi/stripe/resources/order.rbi +3 -492
- data/rbi/stripe/resources/payment_attempt_record.rbi +0 -45
- data/rbi/stripe/resources/payment_intent.rbi +3 -2224
- data/rbi/stripe/resources/payment_link.rbi +14 -291
- data/rbi/stripe/resources/payment_method.rbi +3 -382
- data/rbi/stripe/resources/payment_method_configuration.rbi +0 -486
- data/rbi/stripe/resources/payment_method_domain.rbi +0 -29
- data/rbi/stripe/resources/payment_record.rbi +0 -134
- data/rbi/stripe/resources/payout.rbi +0 -58
- data/rbi/stripe/resources/person.rbi +2 -92
- data/rbi/stripe/resources/plan.rbi +0 -78
- data/rbi/stripe/resources/price.rbi +0 -153
- data/rbi/stripe/resources/product.rbi +0 -120
- data/rbi/stripe/resources/product_feature.rbi +0 -4
- data/rbi/stripe/resources/promotion_code.rbi +0 -50
- data/rbi/stripe/resources/quote.rbi +0 -593
- data/rbi/stripe/resources/quote_line.rbi +0 -66
- data/rbi/stripe/resources/quote_preview_invoice.rbi +4 -184
- data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +0 -101
- data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -20
- data/rbi/stripe/resources/radar/value_list.rbi +0 -32
- data/rbi/stripe/resources/radar/value_list_item.rbi +0 -23
- data/rbi/stripe/resources/refund.rbi +0 -100
- data/rbi/stripe/resources/reporting/report_run.rbi +0 -38
- data/rbi/stripe/resources/reporting/report_type.rbi +0 -11
- data/rbi/stripe/resources/reserve_transaction.rbi +0 -4
- data/rbi/stripe/resources/reversal.rbi +0 -9
- data/rbi/stripe/resources/review.rbi +0 -32
- data/rbi/stripe/resources/setup_attempt.rbi +3 -106
- data/rbi/stripe/resources/setup_intent.rbi +3 -688
- data/rbi/stripe/resources/shipping_rate.rbi +0 -57
- data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -16
- data/rbi/stripe/resources/source.rbi +9 -365
- data/rbi/stripe/resources/source_mandate_notification.rbi +0 -13
- data/rbi/stripe/resources/source_transaction.rbi +0 -29
- data/rbi/stripe/resources/subscription.rbi +0 -431
- data/rbi/stripe/resources/subscription_item.rbi +0 -88
- data/rbi/stripe/resources/subscription_schedule.rbi +0 -504
- data/rbi/stripe/resources/tax/association.rbi +0 -13
- data/rbi/stripe/resources/tax/calculation.rbi +2 -100
- data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -20
- data/rbi/stripe/resources/tax/form.rbi +2 -40
- data/rbi/stripe/resources/tax/registration.rbi +401 -317
- data/rbi/stripe/resources/tax/settings.rbi +0 -26
- data/rbi/stripe/resources/tax/transaction.rbi +1 -73
- data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -12
- data/rbi/stripe/resources/tax_code.rbi +0 -9
- data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -4
- data/rbi/stripe/resources/tax_id.rbi +2 -34
- data/rbi/stripe/resources/tax_rate.rbi +0 -51
- data/rbi/stripe/resources/terminal/configuration.rbi +0 -211
- data/rbi/stripe/resources/terminal/connection_token.rbi +0 -5
- data/rbi/stripe/resources/terminal/location.rbi +0 -40
- data/rbi/stripe/resources/terminal/reader.rbi +0 -158
- data/rbi/stripe/resources/terminal/reader_collected_data.rbi +0 -7
- data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -20
- data/rbi/stripe/resources/token.rbi +5 -235
- data/rbi/stripe/resources/topup.rbi +0 -44
- data/rbi/stripe/resources/transfer.rbi +0 -41
- data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -25
- data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -27
- data/rbi/stripe/resources/treasury/financial_account.rbi +70 -124
- data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -46
- data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -59
- data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -113
- data/rbi/stripe/resources/treasury/outbound_transfer.rbi +28 -84
- data/rbi/stripe/resources/treasury/received_credit.rbi +7 -67
- data/rbi/stripe/resources/treasury/received_debit.rbi +0 -62
- data/rbi/stripe/resources/treasury/transaction.rbi +0 -45
- data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -41
- data/rbi/stripe/resources/usage_record.rbi +0 -5
- data/rbi/stripe/resources/usage_record_summary.rbi +0 -7
- data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -6
- data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -7
- data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -5
- data/rbi/stripe/resources/v2/event.rbi +0 -8
- data/rbi/stripe/resources/v2/event_destination.rbi +0 -19
- data/rbi/stripe/resources/webhook_endpoint.rbi +0 -31
- data/rbi/stripe/services/account_capability_service.rbi +0 -4
- data/rbi/stripe/services/account_external_account_service.rbi +0 -52
- data/rbi/stripe/services/account_link_service.rbi +0 -9
- data/rbi/stripe/services/account_login_link_service.rbi +0 -1
- data/rbi/stripe/services/account_notice_service.rbi +0 -13
- data/rbi/stripe/services/account_person_service.rbi +0 -174
- data/rbi/stripe/services/account_service.rbi +10 -773
- data/rbi/stripe/services/account_session_service.rbi +0 -116
- data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -8
- data/rbi/stripe/services/application_fee_refund_service.rbi +0 -10
- data/rbi/stripe/services/application_fee_service.rbi +0 -11
- data/rbi/stripe/services/apps/secret_service.rbi +0 -24
- data/rbi/stripe/services/balance_service.rbi +0 -1
- data/rbi/stripe/services/balance_transaction_service.rbi +0 -14
- data/rbi/stripe/services/billing/alert_service.rbi +0 -20
- data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -7
- data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -7
- data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -26
- data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -5
- data/rbi/stripe/services/billing/meter_event_service.rbi +0 -5
- data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -8
- data/rbi/stripe/services/billing/meter_service.rbi +0 -21
- data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -76
- data/rbi/stripe/services/billing_portal/session_service.rbi +0 -31
- data/rbi/stripe/services/capital/financing_offer_service.rbi +0 -13
- data/rbi/stripe/services/capital/financing_summary_service.rbi +0 -1
- data/rbi/stripe/services/capital/financing_transaction_service.rbi +0 -9
- data/rbi/stripe/services/charge_service.rbi +0 -346
- data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -4
- data/rbi/stripe/services/checkout/session_service.rbi +2 -395
- data/rbi/stripe/services/climate/order_service.rbi +0 -18
- data/rbi/stripe/services/climate/product_service.rbi +0 -5
- data/rbi/stripe/services/climate/supplier_service.rbi +0 -5
- data/rbi/stripe/services/confirmation_token_service.rbi +0 -1
- data/rbi/stripe/services/country_spec_service.rbi +0 -5
- data/rbi/stripe/services/coupon_service.rbi +0 -30
- data/rbi/stripe/services/credit_note_line_item_service.rbi +0 -4
- data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -33
- data/rbi/stripe/services/credit_note_service.rbi +0 -76
- data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -13
- data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -4
- data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -5
- data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -8
- data/rbi/stripe/services/customer_payment_method_service.rbi +0 -7
- data/rbi/stripe/services/customer_payment_source_service.rbi +0 -37
- data/rbi/stripe/services/customer_service.rbi +1 -117
- data/rbi/stripe/services/customer_session_service.rbi +0 -16
- data/rbi/stripe/services/customer_tax_id_service.rbi +1 -9
- data/rbi/stripe/services/dispute_service.rbi +2 -80
- data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -6
- data/rbi/stripe/services/entitlements/feature_service.rbi +0 -15
- data/rbi/stripe/services/ephemeral_key_service.rbi +0 -6
- data/rbi/stripe/services/event_service.rbi +0 -13
- data/rbi/stripe/services/exchange_rate_service.rbi +0 -5
- data/rbi/stripe/services/file_link_service.rbi +0 -19
- data/rbi/stripe/services/file_service.rbi +0 -18
- data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +0 -4
- data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -5
- data/rbi/stripe/services/financial_connections/account_service.rbi +0 -16
- data/rbi/stripe/services/financial_connections/institution_service.rbi +0 -5
- data/rbi/stripe/services/financial_connections/session_service.rbi +0 -17
- data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -13
- data/rbi/stripe/services/forwarding/request_service.rbi +0 -20
- data/rbi/stripe/services/gift_cards/card_service.rbi +0 -20
- data/rbi/stripe/services/gift_cards/transaction_service.rbi +0 -24
- data/rbi/stripe/services/identity/verification_report_service.rbi +0 -13
- data/rbi/stripe/services/identity/verification_session_service.rbi +0 -43
- data/rbi/stripe/services/invoice_item_service.rbi +0 -81
- data/rbi/stripe/services/invoice_line_item_service.rbi +0 -50
- data/rbi/stripe/services/invoice_payment_service.rbi +0 -5
- data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -9
- data/rbi/stripe/services/invoice_service.rbi +2 -1100
- data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +1 -375
- data/rbi/stripe/services/issuing/authorization_service.rbi +0 -20
- data/rbi/stripe/services/issuing/card_service.rbi +0 -89
- data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -100
- data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +0 -82
- data/rbi/stripe/services/issuing/dispute_service.rbi +0 -123
- data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +0 -6
- data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +0 -10
- data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -38
- data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -7
- data/rbi/stripe/services/issuing/token_service.rbi +0 -14
- data/rbi/stripe/services/issuing/transaction_service.rbi +0 -16
- data/rbi/stripe/services/mandate_service.rbi +0 -1
- data/rbi/stripe/services/margin_service.rbi +0 -15
- data/rbi/stripe/services/order_line_item_service.rbi +0 -4
- data/rbi/stripe/services/order_service.rbi +2 -365
- data/rbi/stripe/services/payment_attempt_record_service.rbi +0 -3
- data/rbi/stripe/services/payment_intent_service.rbi +0 -1764
- data/rbi/stripe/services/payment_link_line_item_service.rbi +0 -4
- data/rbi/stripe/services/payment_link_service.rbi +14 -211
- data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -294
- data/rbi/stripe/services/payment_method_domain_service.rbi +0 -13
- data/rbi/stripe/services/payment_method_service.rbi +0 -149
- data/rbi/stripe/services/payment_record_service.rbi +0 -92
- data/rbi/stripe/services/payout_service.rbi +0 -31
- data/rbi/stripe/services/plan_service.rbi +0 -51
- data/rbi/stripe/services/price_service.rbi +0 -106
- data/rbi/stripe/services/product_feature_service.rbi +0 -7
- data/rbi/stripe/services/product_service.rbi +0 -93
- data/rbi/stripe/services/promotion_code_service.rbi +0 -34
- data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -4
- data/rbi/stripe/services/quote_line_item_service.rbi +0 -4
- data/rbi/stripe/services/quote_line_service.rbi +0 -4
- data/rbi/stripe/services/quote_preview_invoice_service.rbi +0 -4
- data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +0 -4
- data/rbi/stripe/services/quote_service.rbi +0 -440
- data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -12
- data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -15
- data/rbi/stripe/services/radar/value_list_service.rbi +0 -21
- data/rbi/stripe/services/refund_service.rbi +0 -27
- data/rbi/stripe/services/reporting/report_run_service.rbi +0 -21
- data/rbi/stripe/services/reporting/report_type_service.rbi +0 -2
- data/rbi/stripe/services/review_service.rbi +0 -11
- data/rbi/stripe/services/setup_attempt_service.rbi +0 -10
- data/rbi/stripe/services/setup_intent_service.rbi +0 -595
- data/rbi/stripe/services/shipping_rate_service.rbi +0 -39
- data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -5
- data/rbi/stripe/services/source_service.rbi +0 -119
- data/rbi/stripe/services/source_transaction_service.rbi +0 -4
- data/rbi/stripe/services/subscription_item_service.rbi +0 -74
- data/rbi/stripe/services/subscription_item_usage_record_service.rbi +0 -4
- data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +0 -4
- data/rbi/stripe/services/subscription_schedule_service.rbi +0 -405
- data/rbi/stripe/services/subscription_service.rbi +0 -337
- data/rbi/stripe/services/tax/association_service.rbi +0 -2
- data/rbi/stripe/services/tax/calculation_line_item_service.rbi +0 -4
- data/rbi/stripe/services/tax/calculation_service.rbi +1 -40
- data/rbi/stripe/services/tax/form_service.rbi +0 -11
- data/rbi/stripe/services/tax/registration_service.rbi +233 -211
- data/rbi/stripe/services/tax/settings_service.rbi +0 -13
- data/rbi/stripe/services/tax/transaction_line_item_service.rbi +0 -4
- data/rbi/stripe/services/tax/transaction_service.rbi +0 -22
- data/rbi/stripe/services/tax_code_service.rbi +0 -5
- data/rbi/stripe/services/tax_id_service.rbi +1 -17
- data/rbi/stripe/services/tax_rate_service.rbi +0 -32
- data/rbi/stripe/services/terminal/configuration_service.rbi +0 -154
- data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -2
- data/rbi/stripe/services/terminal/location_service.rbi +0 -27
- data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +0 -1
- data/rbi/stripe/services/terminal/reader_service.rbi +0 -78
- data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -114
- data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -4
- data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -138
- data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -5
- data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -6
- data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -120
- data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -1
- data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -7
- data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -10
- data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -5
- data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -14
- data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -14
- data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -16
- data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -16
- data/rbi/stripe/services/token_service.rbi +5 -226
- data/rbi/stripe/services/topup_service.rbi +0 -28
- data/rbi/stripe/services/transfer_reversal_service.rbi +0 -12
- data/rbi/stripe/services/transfer_service.rbi +0 -24
- data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -11
- data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -12
- data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -25
- data/rbi/stripe/services/treasury/financial_account_service.rbi +62 -73
- data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -16
- data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -50
- data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +17 -24
- data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -9
- data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -7
- data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -18
- data/rbi/stripe/services/treasury/transaction_service.rbi +0 -19
- data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -4
- data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -4
- data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -5
- data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -25
- data/rbi/stripe/services/v2/core/event_service.rbi +0 -3
- data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -18
- metadata +2 -2
@@ -11,7 +11,6 @@ module Stripe
|
|
11
11
|
# The end of this phase of the subscription schedule.
|
12
12
|
sig { returns(Integer) }
|
13
13
|
attr_reader :end_date
|
14
|
-
|
15
14
|
# The start of this phase of the subscription schedule.
|
16
15
|
sig { returns(Integer) }
|
17
16
|
attr_reader :start_date
|
@@ -22,7 +21,6 @@ module Stripe
|
|
22
21
|
# The connected account being referenced when `type` is `account`.
|
23
22
|
sig { returns(T.any(String, Stripe::Account)) }
|
24
23
|
attr_reader :account
|
25
|
-
|
26
24
|
# Type of the account referenced.
|
27
25
|
sig { returns(String) }
|
28
26
|
attr_reader :type
|
@@ -30,11 +28,9 @@ module Stripe
|
|
30
28
|
# If Stripe disabled automatic tax, this enum describes why.
|
31
29
|
sig { returns(T.nilable(String)) }
|
32
30
|
attr_reader :disabled_reason
|
33
|
-
|
34
31
|
# Whether Stripe automatically computes tax on invoices created during this phase.
|
35
32
|
sig { returns(T::Boolean) }
|
36
33
|
attr_reader :enabled
|
37
|
-
|
38
34
|
# 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.
|
39
35
|
sig { returns(T.nilable(Liability)) }
|
40
36
|
attr_reader :liability
|
@@ -43,7 +39,6 @@ module Stripe
|
|
43
39
|
# Monetary threshold that triggers the subscription to create an invoice
|
44
40
|
sig { returns(T.nilable(Integer)) }
|
45
41
|
attr_reader :amount_gte
|
46
|
-
|
47
42
|
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
|
48
43
|
sig { returns(T.nilable(T::Boolean)) }
|
49
44
|
attr_reader :reset_billing_cycle_anchor
|
@@ -53,7 +48,6 @@ module Stripe
|
|
53
48
|
# The connected account being referenced when `type` is `account`.
|
54
49
|
sig { returns(T.any(String, Stripe::Account)) }
|
55
50
|
attr_reader :account
|
56
|
-
|
57
51
|
# Type of the account referenced.
|
58
52
|
sig { returns(String) }
|
59
53
|
attr_reader :type
|
@@ -61,11 +55,9 @@ module Stripe
|
|
61
55
|
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
|
62
56
|
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
|
63
57
|
attr_reader :account_tax_ids
|
64
|
-
|
65
58
|
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
|
66
59
|
sig { returns(T.nilable(Integer)) }
|
67
60
|
attr_reader :days_until_due
|
68
|
-
|
69
61
|
# Attribute for field issuer
|
70
62
|
sig { returns(Issuer) }
|
71
63
|
attr_reader :issuer
|
@@ -74,7 +66,6 @@ module Stripe
|
|
74
66
|
# 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 destination account. By default, the entire amount is transferred to the destination.
|
75
67
|
sig { returns(T.nilable(Float)) }
|
76
68
|
attr_reader :amount_percent
|
77
|
-
|
78
69
|
# The account where funds from the payment will be transferred to upon payment success.
|
79
70
|
sig { returns(T.any(String, Stripe::Account)) }
|
80
71
|
attr_reader :destination
|
@@ -82,39 +73,30 @@ module Stripe
|
|
82
73
|
# 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 during this phase of the schedule.
|
83
74
|
sig { returns(T.nilable(Float)) }
|
84
75
|
attr_reader :application_fee_percent
|
85
|
-
|
86
76
|
# Attribute for field automatic_tax
|
87
77
|
sig { returns(AutomaticTax) }
|
88
78
|
attr_reader :automatic_tax
|
89
|
-
|
90
79
|
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
|
91
80
|
sig { returns(String) }
|
92
81
|
attr_reader :billing_cycle_anchor
|
93
|
-
|
94
82
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
|
95
83
|
sig { returns(T.nilable(BillingThresholds)) }
|
96
84
|
attr_reader :billing_thresholds
|
97
|
-
|
98
85
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
|
99
86
|
sig { returns(T.nilable(String)) }
|
100
87
|
attr_reader :collection_method
|
101
|
-
|
102
88
|
# ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
|
103
89
|
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
|
104
90
|
attr_reader :default_payment_method
|
105
|
-
|
106
91
|
# 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.
|
107
92
|
sig { returns(T.nilable(String)) }
|
108
93
|
attr_reader :description
|
109
|
-
|
110
94
|
# Attribute for field invoice_settings
|
111
95
|
sig { returns(InvoiceSettings) }
|
112
96
|
attr_reader :invoice_settings
|
113
|
-
|
114
97
|
# The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
|
115
98
|
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
|
116
99
|
attr_reader :on_behalf_of
|
117
|
-
|
118
100
|
# The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
|
119
101
|
sig { returns(T.nilable(TransferData)) }
|
120
102
|
attr_reader :transfer_data
|
@@ -124,7 +106,6 @@ module Stripe
|
|
124
106
|
# The original price to be migrated.
|
125
107
|
sig { returns(String) }
|
126
108
|
attr_reader :source_price
|
127
|
-
|
128
109
|
# The intended resulting price of the migration.
|
129
110
|
sig { returns(String) }
|
130
111
|
attr_reader :target_price
|
@@ -132,11 +113,9 @@ module Stripe
|
|
132
113
|
# The time at which the price migration encountered an error.
|
133
114
|
sig { returns(Integer) }
|
134
115
|
attr_reader :errored_at
|
135
|
-
|
136
116
|
# The involved price pairs in each failed transition.
|
137
117
|
sig { returns(T::Array[FailedTransition]) }
|
138
118
|
attr_reader :failed_transitions
|
139
|
-
|
140
119
|
# The type of error encountered by the price migration.
|
141
120
|
sig { returns(String) }
|
142
121
|
attr_reader :type
|
@@ -148,7 +127,6 @@ module Stripe
|
|
148
127
|
# The discount end timestamp.
|
149
128
|
sig { returns(T.nilable(Integer)) }
|
150
129
|
attr_reader :timestamp
|
151
|
-
|
152
130
|
# The discount end type.
|
153
131
|
sig { returns(String) }
|
154
132
|
attr_reader :type
|
@@ -156,15 +134,12 @@ module Stripe
|
|
156
134
|
# ID of the coupon to create a new discount for.
|
157
135
|
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
|
158
136
|
attr_reader :coupon
|
159
|
-
|
160
137
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
161
138
|
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
|
162
139
|
attr_reader :discount
|
163
|
-
|
164
140
|
# Details to determine how long the discount should be applied for.
|
165
141
|
sig { returns(T.nilable(DiscountEnd)) }
|
166
142
|
attr_reader :discount_end
|
167
|
-
|
168
143
|
# ID of the promotion code to create a new discount for.
|
169
144
|
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
|
170
145
|
attr_reader :promotion_code
|
@@ -172,15 +147,12 @@ module Stripe
|
|
172
147
|
# The stackable discounts that will be applied to the item.
|
173
148
|
sig { returns(T::Array[Discount]) }
|
174
149
|
attr_reader :discounts
|
175
|
-
|
176
150
|
# ID of the price used to generate the invoice item.
|
177
151
|
sig { returns(T.any(String, Stripe::Price)) }
|
178
152
|
attr_reader :price
|
179
|
-
|
180
153
|
# The quantity of the invoice item.
|
181
154
|
sig { returns(T.nilable(Integer)) }
|
182
155
|
attr_reader :quantity
|
183
|
-
|
184
156
|
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
|
185
157
|
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
|
186
158
|
attr_reader :tax_rates
|
@@ -190,7 +162,6 @@ module Stripe
|
|
190
162
|
# The connected account being referenced when `type` is `account`.
|
191
163
|
sig { returns(T.any(String, Stripe::Account)) }
|
192
164
|
attr_reader :account
|
193
|
-
|
194
165
|
# Type of the account referenced.
|
195
166
|
sig { returns(String) }
|
196
167
|
attr_reader :type
|
@@ -198,11 +169,9 @@ module Stripe
|
|
198
169
|
# If Stripe disabled automatic tax, this enum describes why.
|
199
170
|
sig { returns(T.nilable(String)) }
|
200
171
|
attr_reader :disabled_reason
|
201
|
-
|
202
172
|
# Whether Stripe automatically computes tax on invoices created during this phase.
|
203
173
|
sig { returns(T::Boolean) }
|
204
174
|
attr_reader :enabled
|
205
|
-
|
206
175
|
# 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.
|
207
176
|
sig { returns(T.nilable(Liability)) }
|
208
177
|
attr_reader :liability
|
@@ -211,7 +180,6 @@ module Stripe
|
|
211
180
|
# Monetary threshold that triggers the subscription to create an invoice
|
212
181
|
sig { returns(T.nilable(Integer)) }
|
213
182
|
attr_reader :amount_gte
|
214
|
-
|
215
183
|
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
|
216
184
|
sig { returns(T.nilable(T::Boolean)) }
|
217
185
|
attr_reader :reset_billing_cycle_anchor
|
@@ -221,7 +189,6 @@ module Stripe
|
|
221
189
|
# The discount end timestamp.
|
222
190
|
sig { returns(T.nilable(Integer)) }
|
223
191
|
attr_reader :timestamp
|
224
|
-
|
225
192
|
# The discount end type.
|
226
193
|
sig { returns(String) }
|
227
194
|
attr_reader :type
|
@@ -229,15 +196,12 @@ module Stripe
|
|
229
196
|
# ID of the coupon to create a new discount for.
|
230
197
|
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
|
231
198
|
attr_reader :coupon
|
232
|
-
|
233
199
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
234
200
|
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
|
235
201
|
attr_reader :discount
|
236
|
-
|
237
202
|
# Details to determine how long the discount should be applied for.
|
238
203
|
sig { returns(T.nilable(DiscountEnd)) }
|
239
204
|
attr_reader :discount_end
|
240
|
-
|
241
205
|
# ID of the promotion code to create a new discount for.
|
242
206
|
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
|
243
207
|
attr_reader :promotion_code
|
@@ -247,7 +211,6 @@ module Stripe
|
|
247
211
|
# The connected account being referenced when `type` is `account`.
|
248
212
|
sig { returns(T.any(String, Stripe::Account)) }
|
249
213
|
attr_reader :account
|
250
|
-
|
251
214
|
# Type of the account referenced.
|
252
215
|
sig { returns(String) }
|
253
216
|
attr_reader :type
|
@@ -255,11 +218,9 @@ module Stripe
|
|
255
218
|
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
256
219
|
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
|
257
220
|
attr_reader :account_tax_ids
|
258
|
-
|
259
221
|
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
|
260
222
|
sig { returns(T.nilable(Integer)) }
|
261
223
|
attr_reader :days_until_due
|
262
|
-
|
263
224
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
264
225
|
sig { returns(T.nilable(Issuer)) }
|
265
226
|
attr_reader :issuer
|
@@ -275,7 +236,6 @@ module Stripe
|
|
275
236
|
# The discount end timestamp.
|
276
237
|
sig { returns(T.nilable(Integer)) }
|
277
238
|
attr_reader :timestamp
|
278
|
-
|
279
239
|
# The discount end type.
|
280
240
|
sig { returns(String) }
|
281
241
|
attr_reader :type
|
@@ -283,15 +243,12 @@ module Stripe
|
|
283
243
|
# ID of the coupon to create a new discount for.
|
284
244
|
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
|
285
245
|
attr_reader :coupon
|
286
|
-
|
287
246
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
288
247
|
sig { returns(T.nilable(T.any(String, Stripe::Discount))) }
|
289
248
|
attr_reader :discount
|
290
|
-
|
291
249
|
# Details to determine how long the discount should be applied for.
|
292
250
|
sig { returns(T.nilable(DiscountEnd)) }
|
293
251
|
attr_reader :discount_end
|
294
|
-
|
295
252
|
# ID of the promotion code to create a new discount for.
|
296
253
|
sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
|
297
254
|
attr_reader :promotion_code
|
@@ -300,7 +257,6 @@ module Stripe
|
|
300
257
|
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
|
301
258
|
sig { returns(T.nilable(T::Array[String])) }
|
302
259
|
attr_reader :converts_to
|
303
|
-
|
304
260
|
# Determines the type of trial for this item.
|
305
261
|
sig { returns(String) }
|
306
262
|
attr_reader :type
|
@@ -308,31 +264,24 @@ module Stripe
|
|
308
264
|
# Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
|
309
265
|
sig { returns(T.nilable(BillingThresholds)) }
|
310
266
|
attr_reader :billing_thresholds
|
311
|
-
|
312
267
|
# The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
|
313
268
|
sig { returns(T::Array[Discount]) }
|
314
269
|
attr_reader :discounts
|
315
|
-
|
316
270
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
|
317
271
|
sig { returns(T.nilable(T::Hash[String, String])) }
|
318
272
|
attr_reader :metadata
|
319
|
-
|
320
273
|
# ID of the plan to which the customer should be subscribed.
|
321
274
|
sig { returns(T.any(String, Stripe::Plan)) }
|
322
275
|
attr_reader :plan
|
323
|
-
|
324
276
|
# ID of the price to which the customer should be subscribed.
|
325
277
|
sig { returns(T.any(String, Stripe::Price)) }
|
326
278
|
attr_reader :price
|
327
|
-
|
328
279
|
# Quantity of the plan to which the customer should be subscribed.
|
329
280
|
sig { returns(Integer) }
|
330
281
|
attr_reader :quantity
|
331
|
-
|
332
282
|
# The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
|
333
283
|
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
|
334
284
|
attr_reader :tax_rates
|
335
|
-
|
336
285
|
# Options that configure the trial on the subscription item.
|
337
286
|
sig { returns(T.nilable(Trial)) }
|
338
287
|
attr_reader :trial
|
@@ -346,7 +295,6 @@ module Stripe
|
|
346
295
|
# 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 destination account. By default, the entire amount is transferred to the destination.
|
347
296
|
sig { returns(T.nilable(Float)) }
|
348
297
|
attr_reader :amount_percent
|
349
|
-
|
350
298
|
# The account where funds from the payment will be transferred to upon payment success.
|
351
299
|
sig { returns(T.any(String, Stripe::Account)) }
|
352
300
|
attr_reader :destination
|
@@ -364,95 +312,72 @@ module Stripe
|
|
364
312
|
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
|
365
313
|
sig { returns(T::Array[AddInvoiceItem]) }
|
366
314
|
attr_reader :add_invoice_items
|
367
|
-
|
368
315
|
# 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 during this phase of the schedule.
|
369
316
|
sig { returns(T.nilable(Float)) }
|
370
317
|
attr_reader :application_fee_percent
|
371
|
-
|
372
318
|
# Attribute for field automatic_tax
|
373
319
|
sig { returns(AutomaticTax) }
|
374
320
|
attr_reader :automatic_tax
|
375
|
-
|
376
321
|
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
|
377
322
|
sig { returns(T.nilable(String)) }
|
378
323
|
attr_reader :billing_cycle_anchor
|
379
|
-
|
380
324
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
|
381
325
|
sig { returns(T.nilable(BillingThresholds)) }
|
382
326
|
attr_reader :billing_thresholds
|
383
|
-
|
384
327
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
|
385
328
|
sig { returns(T.nilable(String)) }
|
386
329
|
attr_reader :collection_method
|
387
|
-
|
388
330
|
# ID of the coupon to use during this phase of the subscription schedule.
|
389
331
|
sig { returns(T.nilable(T.any(String, Stripe::Coupon))) }
|
390
332
|
attr_reader :coupon
|
391
|
-
|
392
333
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
393
334
|
sig { returns(String) }
|
394
335
|
attr_reader :currency
|
395
|
-
|
396
336
|
# 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.
|
397
337
|
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
|
398
338
|
attr_reader :default_payment_method
|
399
|
-
|
400
339
|
# The default tax rates to apply to the subscription during this phase of the subscription schedule.
|
401
340
|
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
|
402
341
|
attr_reader :default_tax_rates
|
403
|
-
|
404
342
|
# 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.
|
405
343
|
sig { returns(T.nilable(String)) }
|
406
344
|
attr_reader :description
|
407
|
-
|
408
345
|
# The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
|
409
346
|
sig { returns(T::Array[Discount]) }
|
410
347
|
attr_reader :discounts
|
411
|
-
|
412
348
|
# The end of this phase of the subscription schedule.
|
413
349
|
sig { returns(Integer) }
|
414
350
|
attr_reader :end_date
|
415
|
-
|
416
351
|
# The invoice settings applicable during this phase.
|
417
352
|
sig { returns(T.nilable(InvoiceSettings)) }
|
418
353
|
attr_reader :invoice_settings
|
419
|
-
|
420
354
|
# Subscription items to configure the subscription to during this phase of the subscription schedule.
|
421
355
|
sig { returns(T::Array[Item]) }
|
422
356
|
attr_reader :items
|
423
|
-
|
424
357
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.
|
425
358
|
sig { returns(T.nilable(T::Hash[String, String])) }
|
426
359
|
attr_reader :metadata
|
427
|
-
|
428
360
|
# The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
|
429
361
|
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
|
430
362
|
attr_reader :on_behalf_of
|
431
|
-
|
432
363
|
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
|
433
364
|
sig { returns(T.nilable(PauseCollection)) }
|
434
365
|
attr_reader :pause_collection
|
435
|
-
|
436
366
|
# If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`.
|
437
367
|
sig { returns(String) }
|
438
368
|
attr_reader :proration_behavior
|
439
|
-
|
440
369
|
# The start of this phase of the subscription schedule.
|
441
370
|
sig { returns(Integer) }
|
442
371
|
attr_reader :start_date
|
443
|
-
|
444
372
|
# The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
|
445
373
|
sig { returns(T.nilable(TransferData)) }
|
446
374
|
attr_reader :transfer_data
|
447
|
-
|
448
375
|
# Specify behavior of the trial when crossing schedule phase boundaries
|
449
376
|
sig { returns(T.nilable(String)) }
|
450
377
|
attr_reader :trial_continuation
|
451
|
-
|
452
378
|
# When the trial ends within the phase.
|
453
379
|
sig { returns(T.nilable(Integer)) }
|
454
380
|
attr_reader :trial_end
|
455
|
-
|
456
381
|
# Settings related to any trials on the subscription during this phase.
|
457
382
|
sig { returns(T.nilable(TrialSettings)) }
|
458
383
|
attr_reader :trial_settings
|
@@ -461,15 +386,12 @@ module Stripe
|
|
461
386
|
# ID of the prebilling invoice.
|
462
387
|
sig { returns(T.any(String, Stripe::Invoice)) }
|
463
388
|
attr_reader :invoice
|
464
|
-
|
465
389
|
# The end of the last period for which the invoice pre-bills.
|
466
390
|
sig { returns(Integer) }
|
467
391
|
attr_reader :period_end
|
468
|
-
|
469
392
|
# The start of the first period for which the invoice pre-bills.
|
470
393
|
sig { returns(Integer) }
|
471
394
|
attr_reader :period_start
|
472
|
-
|
473
395
|
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
|
474
396
|
sig { returns(String) }
|
475
397
|
attr_reader :update_behavior
|
@@ -477,105 +399,80 @@ module Stripe
|
|
477
399
|
# ID of the Connect Application that created the schedule.
|
478
400
|
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
|
479
401
|
attr_reader :application
|
480
|
-
|
481
402
|
# 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.
|
482
403
|
sig { returns(String) }
|
483
404
|
attr_reader :billing_behavior
|
484
|
-
|
485
405
|
# Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
|
486
406
|
sig { returns(T.nilable(Integer)) }
|
487
407
|
attr_reader :canceled_at
|
488
|
-
|
489
408
|
# Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
|
490
409
|
sig { returns(T.nilable(Integer)) }
|
491
410
|
attr_reader :completed_at
|
492
|
-
|
493
411
|
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
494
412
|
sig { returns(Integer) }
|
495
413
|
attr_reader :created
|
496
|
-
|
497
414
|
# Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.
|
498
415
|
sig { returns(T.nilable(CurrentPhase)) }
|
499
416
|
attr_reader :current_phase
|
500
|
-
|
501
417
|
# ID of the customer who owns the subscription schedule.
|
502
418
|
sig { returns(T.any(String, Stripe::Customer)) }
|
503
419
|
attr_reader :customer
|
504
|
-
|
505
420
|
# Attribute for field default_settings
|
506
421
|
sig { returns(DefaultSettings) }
|
507
422
|
attr_reader :default_settings
|
508
|
-
|
509
423
|
# 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.
|
510
424
|
sig { returns(String) }
|
511
425
|
attr_reader :end_behavior
|
512
|
-
|
513
426
|
# Unique identifier for the object.
|
514
427
|
sig { returns(String) }
|
515
428
|
attr_reader :id
|
516
|
-
|
517
429
|
# Details of the most recent price migration that failed for the subscription schedule.
|
518
430
|
sig { returns(T.nilable(LastPriceMigrationError)) }
|
519
431
|
attr_reader :last_price_migration_error
|
520
|
-
|
521
432
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
522
433
|
sig { returns(T::Boolean) }
|
523
434
|
attr_reader :livemode
|
524
|
-
|
525
435
|
# 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.
|
526
436
|
sig { returns(T.nilable(T::Hash[String, String])) }
|
527
437
|
attr_reader :metadata
|
528
|
-
|
529
438
|
# String representing the object's type. Objects of the same type share the same value.
|
530
439
|
sig { returns(String) }
|
531
440
|
attr_reader :object
|
532
|
-
|
533
441
|
# Configuration for the subscription schedule's phases.
|
534
442
|
sig { returns(T::Array[Phase]) }
|
535
443
|
attr_reader :phases
|
536
|
-
|
537
444
|
# Time period and invoice for a Subscription billed in advance.
|
538
445
|
sig { returns(T.nilable(Prebilling)) }
|
539
446
|
attr_reader :prebilling
|
540
|
-
|
541
447
|
# Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
|
542
448
|
sig { returns(T.nilable(Integer)) }
|
543
449
|
attr_reader :released_at
|
544
|
-
|
545
450
|
# ID of the subscription once managed by the subscription schedule (if it is released).
|
546
451
|
sig { returns(T.nilable(String)) }
|
547
452
|
attr_reader :released_subscription
|
548
|
-
|
549
453
|
# The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).
|
550
454
|
sig { returns(String) }
|
551
455
|
attr_reader :status
|
552
|
-
|
553
456
|
# ID of the subscription managed by the subscription schedule.
|
554
457
|
sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
|
555
458
|
attr_reader :subscription
|
556
|
-
|
557
459
|
# ID of the test clock this subscription schedule belongs to.
|
558
460
|
sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
|
559
461
|
attr_reader :test_clock
|
560
|
-
|
561
462
|
class ListParams < Stripe::RequestParams
|
562
463
|
class CanceledAt < Stripe::RequestParams
|
563
464
|
# Minimum value to filter by (exclusive)
|
564
465
|
sig { returns(Integer) }
|
565
466
|
attr_accessor :gt
|
566
|
-
|
567
467
|
# Minimum value to filter by (inclusive)
|
568
468
|
sig { returns(Integer) }
|
569
469
|
attr_accessor :gte
|
570
|
-
|
571
470
|
# Maximum value to filter by (exclusive)
|
572
471
|
sig { returns(Integer) }
|
573
472
|
attr_accessor :lt
|
574
|
-
|
575
473
|
# Maximum value to filter by (inclusive)
|
576
474
|
sig { returns(Integer) }
|
577
475
|
attr_accessor :lte
|
578
|
-
|
579
476
|
sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
|
580
477
|
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
|
581
478
|
end
|
@@ -583,19 +480,15 @@ module Stripe
|
|
583
480
|
# Minimum value to filter by (exclusive)
|
584
481
|
sig { returns(Integer) }
|
585
482
|
attr_accessor :gt
|
586
|
-
|
587
483
|
# Minimum value to filter by (inclusive)
|
588
484
|
sig { returns(Integer) }
|
589
485
|
attr_accessor :gte
|
590
|
-
|
591
486
|
# Maximum value to filter by (exclusive)
|
592
487
|
sig { returns(Integer) }
|
593
488
|
attr_accessor :lt
|
594
|
-
|
595
489
|
# Maximum value to filter by (inclusive)
|
596
490
|
sig { returns(Integer) }
|
597
491
|
attr_accessor :lte
|
598
|
-
|
599
492
|
sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
|
600
493
|
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
|
601
494
|
end
|
@@ -603,19 +496,15 @@ module Stripe
|
|
603
496
|
# Minimum value to filter by (exclusive)
|
604
497
|
sig { returns(Integer) }
|
605
498
|
attr_accessor :gt
|
606
|
-
|
607
499
|
# Minimum value to filter by (inclusive)
|
608
500
|
sig { returns(Integer) }
|
609
501
|
attr_accessor :gte
|
610
|
-
|
611
502
|
# Maximum value to filter by (exclusive)
|
612
503
|
sig { returns(Integer) }
|
613
504
|
attr_accessor :lt
|
614
|
-
|
615
505
|
# Maximum value to filter by (inclusive)
|
616
506
|
sig { returns(Integer) }
|
617
507
|
attr_accessor :lte
|
618
|
-
|
619
508
|
sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
|
620
509
|
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
|
621
510
|
end
|
@@ -623,62 +512,48 @@ module Stripe
|
|
623
512
|
# Minimum value to filter by (exclusive)
|
624
513
|
sig { returns(Integer) }
|
625
514
|
attr_accessor :gt
|
626
|
-
|
627
515
|
# Minimum value to filter by (inclusive)
|
628
516
|
sig { returns(Integer) }
|
629
517
|
attr_accessor :gte
|
630
|
-
|
631
518
|
# Maximum value to filter by (exclusive)
|
632
519
|
sig { returns(Integer) }
|
633
520
|
attr_accessor :lt
|
634
|
-
|
635
521
|
# Maximum value to filter by (inclusive)
|
636
522
|
sig { returns(Integer) }
|
637
523
|
attr_accessor :lte
|
638
|
-
|
639
524
|
sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
|
640
525
|
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
|
641
526
|
end
|
642
527
|
# Only return subscription schedules that were created canceled the given date interval.
|
643
528
|
sig { returns(T.any(::Stripe::SubscriptionSchedule::ListParams::CanceledAt, Integer)) }
|
644
529
|
attr_accessor :canceled_at
|
645
|
-
|
646
530
|
# Only return subscription schedules that completed during the given date interval.
|
647
531
|
sig { returns(T.any(::Stripe::SubscriptionSchedule::ListParams::CompletedAt, Integer)) }
|
648
532
|
attr_accessor :completed_at
|
649
|
-
|
650
533
|
# Only return subscription schedules that were created during the given date interval.
|
651
534
|
sig { returns(T.any(::Stripe::SubscriptionSchedule::ListParams::Created, Integer)) }
|
652
535
|
attr_accessor :created
|
653
|
-
|
654
536
|
# Only return subscription schedules for the given customer.
|
655
537
|
sig { returns(String) }
|
656
538
|
attr_accessor :customer
|
657
|
-
|
658
539
|
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
659
540
|
sig { returns(String) }
|
660
541
|
attr_accessor :ending_before
|
661
|
-
|
662
542
|
# Specifies which fields in the response should be expanded.
|
663
543
|
sig { returns(T::Array[String]) }
|
664
544
|
attr_accessor :expand
|
665
|
-
|
666
545
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
667
546
|
sig { returns(Integer) }
|
668
547
|
attr_accessor :limit
|
669
|
-
|
670
548
|
# Only return subscription schedules that were released during the given date interval.
|
671
549
|
sig { returns(T.any(::Stripe::SubscriptionSchedule::ListParams::ReleasedAt, Integer)) }
|
672
550
|
attr_accessor :released_at
|
673
|
-
|
674
551
|
# Only return subscription schedules that have not started yet.
|
675
552
|
sig { returns(T::Boolean) }
|
676
553
|
attr_accessor :scheduled
|
677
|
-
|
678
554
|
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
679
555
|
sig { returns(String) }
|
680
556
|
attr_accessor :starting_after
|
681
|
-
|
682
557
|
sig {
|
683
558
|
params(canceled_at: T.any(::Stripe::SubscriptionSchedule::ListParams::CanceledAt, Integer), completed_at: T.any(::Stripe::SubscriptionSchedule::ListParams::CompletedAt, Integer), created: T.any(::Stripe::SubscriptionSchedule::ListParams::Created, Integer), customer: String, ending_before: String, expand: T::Array[String], limit: Integer, released_at: T.any(::Stripe::SubscriptionSchedule::ListParams::ReleasedAt, Integer), scheduled: T::Boolean, starting_after: String).void
|
684
559
|
}
|
@@ -702,24 +577,20 @@ module Stripe
|
|
702
577
|
# The connected account being referenced when `type` is `account`.
|
703
578
|
sig { returns(String) }
|
704
579
|
attr_accessor :account
|
705
|
-
|
706
580
|
# Type of the account referenced in the request.
|
707
581
|
sig { returns(String) }
|
708
582
|
attr_accessor :type
|
709
|
-
|
710
583
|
sig { params(account: String, type: String).void }
|
711
584
|
def initialize(account: nil, type: nil); end
|
712
585
|
end
|
713
586
|
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
714
587
|
sig { returns(T::Boolean) }
|
715
588
|
attr_accessor :enabled
|
716
|
-
|
717
589
|
# 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.
|
718
590
|
sig {
|
719
591
|
returns(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::AutomaticTax::Liability)
|
720
592
|
}
|
721
593
|
attr_accessor :liability
|
722
|
-
|
723
594
|
sig {
|
724
595
|
params(enabled: T::Boolean, liability: ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::AutomaticTax::Liability).void
|
725
596
|
}
|
@@ -729,11 +600,9 @@ module Stripe
|
|
729
600
|
# Monetary threshold that triggers the subscription to advance to a new billing period
|
730
601
|
sig { returns(Integer) }
|
731
602
|
attr_accessor :amount_gte
|
732
|
-
|
733
603
|
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
|
734
604
|
sig { returns(T::Boolean) }
|
735
605
|
attr_accessor :reset_billing_cycle_anchor
|
736
|
-
|
737
606
|
sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
|
738
607
|
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
|
739
608
|
end
|
@@ -742,28 +611,23 @@ module Stripe
|
|
742
611
|
# The connected account being referenced when `type` is `account`.
|
743
612
|
sig { returns(String) }
|
744
613
|
attr_accessor :account
|
745
|
-
|
746
614
|
# Type of the account referenced in the request.
|
747
615
|
sig { returns(String) }
|
748
616
|
attr_accessor :type
|
749
|
-
|
750
617
|
sig { params(account: String, type: String).void }
|
751
618
|
def initialize(account: nil, type: nil); end
|
752
619
|
end
|
753
620
|
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
|
754
621
|
sig { returns(T.nilable(T::Array[String])) }
|
755
622
|
attr_accessor :account_tax_ids
|
756
|
-
|
757
623
|
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
|
758
624
|
sig { returns(Integer) }
|
759
625
|
attr_accessor :days_until_due
|
760
|
-
|
761
626
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
762
627
|
sig {
|
763
628
|
returns(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::InvoiceSettings::Issuer)
|
764
629
|
}
|
765
630
|
attr_accessor :issuer
|
766
|
-
|
767
631
|
sig {
|
768
632
|
params(account_tax_ids: T.nilable(T::Array[String]), days_until_due: Integer, issuer: ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::InvoiceSettings::Issuer).void
|
769
633
|
}
|
@@ -773,60 +637,48 @@ module Stripe
|
|
773
637
|
# 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 destination account. By default, the entire amount is transferred to the destination.
|
774
638
|
sig { returns(Float) }
|
775
639
|
attr_accessor :amount_percent
|
776
|
-
|
777
640
|
# ID of an existing, connected Stripe account.
|
778
641
|
sig { returns(String) }
|
779
642
|
attr_accessor :destination
|
780
|
-
|
781
643
|
sig { params(amount_percent: Float, destination: String).void }
|
782
644
|
def initialize(amount_percent: nil, destination: nil); end
|
783
645
|
end
|
784
646
|
# 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).
|
785
647
|
sig { returns(Float) }
|
786
648
|
attr_accessor :application_fee_percent
|
787
|
-
|
788
649
|
# Default settings for automatic tax computation.
|
789
650
|
sig { returns(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::AutomaticTax) }
|
790
651
|
attr_accessor :automatic_tax
|
791
|
-
|
792
652
|
# 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/docs/billing/subscriptions/billing-cycle).
|
793
653
|
sig { returns(String) }
|
794
654
|
attr_accessor :billing_cycle_anchor
|
795
|
-
|
796
655
|
# 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.
|
797
656
|
sig {
|
798
657
|
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::BillingThresholds))
|
799
658
|
}
|
800
659
|
attr_accessor :billing_thresholds
|
801
|
-
|
802
660
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
|
803
661
|
sig { returns(String) }
|
804
662
|
attr_accessor :collection_method
|
805
|
-
|
806
663
|
# 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.
|
807
664
|
sig { returns(String) }
|
808
665
|
attr_accessor :default_payment_method
|
809
|
-
|
810
666
|
# 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.
|
811
667
|
sig { returns(T.nilable(String)) }
|
812
668
|
attr_accessor :description
|
813
|
-
|
814
669
|
# All invoices will be billed using the specified settings.
|
815
670
|
sig {
|
816
671
|
returns(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::InvoiceSettings)
|
817
672
|
}
|
818
673
|
attr_accessor :invoice_settings
|
819
|
-
|
820
674
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
821
675
|
sig { returns(T.nilable(String)) }
|
822
676
|
attr_accessor :on_behalf_of
|
823
|
-
|
824
677
|
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
825
678
|
sig {
|
826
679
|
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::TransferData))
|
827
680
|
}
|
828
681
|
attr_accessor :transfer_data
|
829
|
-
|
830
682
|
sig {
|
831
683
|
params(application_fee_percent: Float, automatic_tax: ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::AutomaticTax, billing_cycle_anchor: String, billing_thresholds: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::BillingThresholds), collection_method: String, default_payment_method: String, description: T.nilable(String), invoice_settings: ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::InvoiceSettings, on_behalf_of: T.nilable(String), transfer_data: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::TransferData)).void
|
832
684
|
}
|
@@ -851,11 +703,9 @@ module Stripe
|
|
851
703
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
852
704
|
sig { returns(String) }
|
853
705
|
attr_accessor :interval
|
854
|
-
|
855
706
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
856
707
|
sig { returns(Integer) }
|
857
708
|
attr_accessor :interval_count
|
858
|
-
|
859
709
|
sig { params(interval: String, interval_count: Integer).void }
|
860
710
|
def initialize(interval: nil, interval_count: nil); end
|
861
711
|
end
|
@@ -864,15 +714,12 @@ module Stripe
|
|
864
714
|
returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration)
|
865
715
|
}
|
866
716
|
attr_accessor :duration
|
867
|
-
|
868
717
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
869
718
|
sig { returns(Integer) }
|
870
719
|
attr_accessor :timestamp
|
871
|
-
|
872
720
|
# The type of calculation made to determine when the discount ends.
|
873
721
|
sig { returns(String) }
|
874
722
|
attr_accessor :type
|
875
|
-
|
876
723
|
sig {
|
877
724
|
params(duration: ::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
|
878
725
|
}
|
@@ -881,21 +728,17 @@ module Stripe
|
|
881
728
|
# ID of the coupon to create a new discount for.
|
882
729
|
sig { returns(String) }
|
883
730
|
attr_accessor :coupon
|
884
|
-
|
885
731
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
886
732
|
sig { returns(String) }
|
887
733
|
attr_accessor :discount
|
888
|
-
|
889
734
|
# Details to determine how long the discount should be applied for.
|
890
735
|
sig {
|
891
736
|
returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd)
|
892
737
|
}
|
893
738
|
attr_accessor :discount_end
|
894
|
-
|
895
739
|
# ID of the promotion code to create a new discount for.
|
896
740
|
sig { returns(String) }
|
897
741
|
attr_accessor :promotion_code
|
898
|
-
|
899
742
|
sig {
|
900
743
|
params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount::DiscountEnd, promotion_code: String).void
|
901
744
|
}
|
@@ -905,23 +748,18 @@ module Stripe
|
|
905
748
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
906
749
|
sig { returns(String) }
|
907
750
|
attr_accessor :currency
|
908
|
-
|
909
751
|
# The ID of the product that this price will belong to.
|
910
752
|
sig { returns(String) }
|
911
753
|
attr_accessor :product
|
912
|
-
|
913
754
|
# Only required if a [default tax behavior](https://stripe.com/docs/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.
|
914
755
|
sig { returns(String) }
|
915
756
|
attr_accessor :tax_behavior
|
916
|
-
|
917
757
|
# 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.
|
918
758
|
sig { returns(Integer) }
|
919
759
|
attr_accessor :unit_amount
|
920
|
-
|
921
760
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
922
761
|
sig { returns(String) }
|
923
762
|
attr_accessor :unit_amount_decimal
|
924
|
-
|
925
763
|
sig {
|
926
764
|
params(currency: String, product: String, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
|
927
765
|
}
|
@@ -938,25 +776,20 @@ module Stripe
|
|
938
776
|
returns(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount])
|
939
777
|
}
|
940
778
|
attr_accessor :discounts
|
941
|
-
|
942
779
|
# The ID of the price object. One of `price` or `price_data` is required.
|
943
780
|
sig { returns(String) }
|
944
781
|
attr_accessor :price
|
945
|
-
|
946
782
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
947
783
|
sig {
|
948
784
|
returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::PriceData)
|
949
785
|
}
|
950
786
|
attr_accessor :price_data
|
951
|
-
|
952
787
|
# Quantity for this item. Defaults to 1.
|
953
788
|
sig { returns(Integer) }
|
954
789
|
attr_accessor :quantity
|
955
|
-
|
956
790
|
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
|
957
791
|
sig { returns(T.nilable(T::Array[String])) }
|
958
792
|
attr_accessor :tax_rates
|
959
|
-
|
960
793
|
sig {
|
961
794
|
params(discounts: T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::Discount], price: String, price_data: ::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
|
962
795
|
}
|
@@ -973,24 +806,20 @@ module Stripe
|
|
973
806
|
# The connected account being referenced when `type` is `account`.
|
974
807
|
sig { returns(String) }
|
975
808
|
attr_accessor :account
|
976
|
-
|
977
809
|
# Type of the account referenced in the request.
|
978
810
|
sig { returns(String) }
|
979
811
|
attr_accessor :type
|
980
|
-
|
981
812
|
sig { params(account: String, type: String).void }
|
982
813
|
def initialize(account: nil, type: nil); end
|
983
814
|
end
|
984
815
|
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
985
816
|
sig { returns(T::Boolean) }
|
986
817
|
attr_accessor :enabled
|
987
|
-
|
988
818
|
# 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.
|
989
819
|
sig {
|
990
820
|
returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::AutomaticTax::Liability)
|
991
821
|
}
|
992
822
|
attr_accessor :liability
|
993
|
-
|
994
823
|
sig {
|
995
824
|
params(enabled: T::Boolean, liability: ::Stripe::SubscriptionSchedule::CreateParams::Phase::AutomaticTax::Liability).void
|
996
825
|
}
|
@@ -1000,11 +829,9 @@ module Stripe
|
|
1000
829
|
# Monetary threshold that triggers the subscription to advance to a new billing period
|
1001
830
|
sig { returns(Integer) }
|
1002
831
|
attr_accessor :amount_gte
|
1003
|
-
|
1004
832
|
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
|
1005
833
|
sig { returns(T::Boolean) }
|
1006
834
|
attr_accessor :reset_billing_cycle_anchor
|
1007
|
-
|
1008
835
|
sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
|
1009
836
|
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
|
1010
837
|
end
|
@@ -1014,11 +841,9 @@ module Stripe
|
|
1014
841
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1015
842
|
sig { returns(String) }
|
1016
843
|
attr_accessor :interval
|
1017
|
-
|
1018
844
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1019
845
|
sig { returns(Integer) }
|
1020
846
|
attr_accessor :interval_count
|
1021
|
-
|
1022
847
|
sig { params(interval: String, interval_count: Integer).void }
|
1023
848
|
def initialize(interval: nil, interval_count: nil); end
|
1024
849
|
end
|
@@ -1027,15 +852,12 @@ module Stripe
|
|
1027
852
|
returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount::DiscountEnd::Duration)
|
1028
853
|
}
|
1029
854
|
attr_accessor :duration
|
1030
|
-
|
1031
855
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1032
856
|
sig { returns(Integer) }
|
1033
857
|
attr_accessor :timestamp
|
1034
|
-
|
1035
858
|
# The type of calculation made to determine when the discount ends.
|
1036
859
|
sig { returns(String) }
|
1037
860
|
attr_accessor :type
|
1038
|
-
|
1039
861
|
sig {
|
1040
862
|
params(duration: ::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
|
1041
863
|
}
|
@@ -1044,21 +866,17 @@ module Stripe
|
|
1044
866
|
# ID of the coupon to create a new discount for.
|
1045
867
|
sig { returns(String) }
|
1046
868
|
attr_accessor :coupon
|
1047
|
-
|
1048
869
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1049
870
|
sig { returns(String) }
|
1050
871
|
attr_accessor :discount
|
1051
|
-
|
1052
872
|
# Details to determine how long the discount should be applied for.
|
1053
873
|
sig {
|
1054
874
|
returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount::DiscountEnd)
|
1055
875
|
}
|
1056
876
|
attr_accessor :discount_end
|
1057
|
-
|
1058
877
|
# ID of the promotion code to create a new discount for.
|
1059
878
|
sig { returns(String) }
|
1060
879
|
attr_accessor :promotion_code
|
1061
|
-
|
1062
880
|
sig {
|
1063
881
|
params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount::DiscountEnd, promotion_code: String).void
|
1064
882
|
}
|
@@ -1069,28 +887,23 @@ module Stripe
|
|
1069
887
|
# The connected account being referenced when `type` is `account`.
|
1070
888
|
sig { returns(String) }
|
1071
889
|
attr_accessor :account
|
1072
|
-
|
1073
890
|
# Type of the account referenced in the request.
|
1074
891
|
sig { returns(String) }
|
1075
892
|
attr_accessor :type
|
1076
|
-
|
1077
893
|
sig { params(account: String, type: String).void }
|
1078
894
|
def initialize(account: nil, type: nil); end
|
1079
895
|
end
|
1080
896
|
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
1081
897
|
sig { returns(T.nilable(T::Array[String])) }
|
1082
898
|
attr_accessor :account_tax_ids
|
1083
|
-
|
1084
899
|
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
|
1085
900
|
sig { returns(Integer) }
|
1086
901
|
attr_accessor :days_until_due
|
1087
|
-
|
1088
902
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
1089
903
|
sig {
|
1090
904
|
returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::InvoiceSettings::Issuer)
|
1091
905
|
}
|
1092
906
|
attr_accessor :issuer
|
1093
|
-
|
1094
907
|
sig {
|
1095
908
|
params(account_tax_ids: T.nilable(T::Array[String]), days_until_due: Integer, issuer: ::Stripe::SubscriptionSchedule::CreateParams::Phase::InvoiceSettings::Issuer).void
|
1096
909
|
}
|
@@ -1101,7 +914,6 @@ module Stripe
|
|
1101
914
|
# 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/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
1102
915
|
sig { returns(Integer) }
|
1103
916
|
attr_accessor :usage_gte
|
1104
|
-
|
1105
917
|
sig { params(usage_gte: Integer).void }
|
1106
918
|
def initialize(usage_gte: nil); end
|
1107
919
|
end
|
@@ -1111,11 +923,9 @@ module Stripe
|
|
1111
923
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1112
924
|
sig { returns(String) }
|
1113
925
|
attr_accessor :interval
|
1114
|
-
|
1115
926
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1116
927
|
sig { returns(Integer) }
|
1117
928
|
attr_accessor :interval_count
|
1118
|
-
|
1119
929
|
sig { params(interval: String, interval_count: Integer).void }
|
1120
930
|
def initialize(interval: nil, interval_count: nil); end
|
1121
931
|
end
|
@@ -1124,15 +934,12 @@ module Stripe
|
|
1124
934
|
returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount::DiscountEnd::Duration)
|
1125
935
|
}
|
1126
936
|
attr_accessor :duration
|
1127
|
-
|
1128
937
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1129
938
|
sig { returns(Integer) }
|
1130
939
|
attr_accessor :timestamp
|
1131
|
-
|
1132
940
|
# The type of calculation made to determine when the discount ends.
|
1133
941
|
sig { returns(String) }
|
1134
942
|
attr_accessor :type
|
1135
|
-
|
1136
943
|
sig {
|
1137
944
|
params(duration: ::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
|
1138
945
|
}
|
@@ -1141,21 +948,17 @@ module Stripe
|
|
1141
948
|
# ID of the coupon to create a new discount for.
|
1142
949
|
sig { returns(String) }
|
1143
950
|
attr_accessor :coupon
|
1144
|
-
|
1145
951
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1146
952
|
sig { returns(String) }
|
1147
953
|
attr_accessor :discount
|
1148
|
-
|
1149
954
|
# Details to determine how long the discount should be applied for.
|
1150
955
|
sig {
|
1151
956
|
returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount::DiscountEnd)
|
1152
957
|
}
|
1153
958
|
attr_accessor :discount_end
|
1154
|
-
|
1155
959
|
# ID of the promotion code to create a new discount for.
|
1156
960
|
sig { returns(String) }
|
1157
961
|
attr_accessor :promotion_code
|
1158
|
-
|
1159
962
|
sig {
|
1160
963
|
params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount::DiscountEnd, promotion_code: String).void
|
1161
964
|
}
|
@@ -1166,40 +969,32 @@ module Stripe
|
|
1166
969
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
1167
970
|
sig { returns(String) }
|
1168
971
|
attr_accessor :interval
|
1169
|
-
|
1170
972
|
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
1171
973
|
sig { returns(Integer) }
|
1172
974
|
attr_accessor :interval_count
|
1173
|
-
|
1174
975
|
sig { params(interval: String, interval_count: Integer).void }
|
1175
976
|
def initialize(interval: nil, interval_count: nil); end
|
1176
977
|
end
|
1177
978
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
1178
979
|
sig { returns(String) }
|
1179
980
|
attr_accessor :currency
|
1180
|
-
|
1181
981
|
# The ID of the product that this price will belong to.
|
1182
982
|
sig { returns(String) }
|
1183
983
|
attr_accessor :product
|
1184
|
-
|
1185
984
|
# The recurring components of a price such as `interval` and `interval_count`.
|
1186
985
|
sig {
|
1187
986
|
returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::PriceData::Recurring)
|
1188
987
|
}
|
1189
988
|
attr_accessor :recurring
|
1190
|
-
|
1191
989
|
# Only required if a [default tax behavior](https://stripe.com/docs/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.
|
1192
990
|
sig { returns(String) }
|
1193
991
|
attr_accessor :tax_behavior
|
1194
|
-
|
1195
992
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
1196
993
|
sig { returns(Integer) }
|
1197
994
|
attr_accessor :unit_amount
|
1198
|
-
|
1199
995
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
1200
996
|
sig { returns(String) }
|
1201
997
|
attr_accessor :unit_amount_decimal
|
1202
|
-
|
1203
998
|
sig {
|
1204
999
|
params(currency: String, product: String, recurring: ::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
|
1205
1000
|
}
|
@@ -1216,11 +1011,9 @@ module Stripe
|
|
1216
1011
|
# 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.
|
1217
1012
|
sig { returns(T::Array[String]) }
|
1218
1013
|
attr_accessor :converts_to
|
1219
|
-
|
1220
1014
|
# Determines the type of trial for this item.
|
1221
1015
|
sig { returns(String) }
|
1222
1016
|
attr_accessor :type
|
1223
|
-
|
1224
1017
|
sig { params(converts_to: T::Array[String], type: String).void }
|
1225
1018
|
def initialize(converts_to: nil, type: nil); end
|
1226
1019
|
end
|
@@ -1229,41 +1022,32 @@ module Stripe
|
|
1229
1022
|
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::BillingThresholds))
|
1230
1023
|
}
|
1231
1024
|
attr_accessor :billing_thresholds
|
1232
|
-
|
1233
1025
|
# The coupons to redeem into discounts for the subscription item.
|
1234
1026
|
sig {
|
1235
1027
|
returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount]))
|
1236
1028
|
}
|
1237
1029
|
attr_accessor :discounts
|
1238
|
-
|
1239
1030
|
# Set of [key-value pairs](https://stripe.com/docs/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`.
|
1240
1031
|
sig { returns(T::Hash[String, String]) }
|
1241
1032
|
attr_accessor :metadata
|
1242
|
-
|
1243
1033
|
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
|
1244
1034
|
sig { returns(String) }
|
1245
1035
|
attr_accessor :plan
|
1246
|
-
|
1247
1036
|
# The ID of the price object.
|
1248
1037
|
sig { returns(String) }
|
1249
1038
|
attr_accessor :price
|
1250
|
-
|
1251
1039
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
|
1252
1040
|
sig { returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::PriceData) }
|
1253
1041
|
attr_accessor :price_data
|
1254
|
-
|
1255
1042
|
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
|
1256
1043
|
sig { returns(Integer) }
|
1257
1044
|
attr_accessor :quantity
|
1258
|
-
|
1259
1045
|
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
1260
1046
|
sig { returns(T.nilable(T::Array[String])) }
|
1261
1047
|
attr_accessor :tax_rates
|
1262
|
-
|
1263
1048
|
# Options that configure the trial on the subscription item.
|
1264
1049
|
sig { returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Trial) }
|
1265
1050
|
attr_accessor :trial
|
1266
|
-
|
1267
1051
|
sig {
|
1268
1052
|
params(billing_thresholds: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::BillingThresholds), discounts: T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount]), metadata: T::Hash[String, String], plan: String, price: String, price_data: ::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String]), trial: ::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Trial).void
|
1269
1053
|
}
|
@@ -1283,7 +1067,6 @@ module Stripe
|
|
1283
1067
|
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
1284
1068
|
sig { returns(String) }
|
1285
1069
|
attr_accessor :behavior
|
1286
|
-
|
1287
1070
|
sig { params(behavior: String).void }
|
1288
1071
|
def initialize(behavior: nil); end
|
1289
1072
|
end
|
@@ -1291,11 +1074,9 @@ module Stripe
|
|
1291
1074
|
# 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 destination account. By default, the entire amount is transferred to the destination.
|
1292
1075
|
sig { returns(Float) }
|
1293
1076
|
attr_accessor :amount_percent
|
1294
|
-
|
1295
1077
|
# ID of an existing, connected Stripe account.
|
1296
1078
|
sig { returns(String) }
|
1297
1079
|
attr_accessor :destination
|
1298
|
-
|
1299
1080
|
sig { params(amount_percent: Float, destination: String).void }
|
1300
1081
|
def initialize(amount_percent: nil, destination: nil); end
|
1301
1082
|
end
|
@@ -1304,7 +1085,6 @@ module Stripe
|
|
1304
1085
|
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
1305
1086
|
sig { returns(String) }
|
1306
1087
|
attr_accessor :prorate_up_front
|
1307
|
-
|
1308
1088
|
sig { params(prorate_up_front: String).void }
|
1309
1089
|
def initialize(prorate_up_front: nil); end
|
1310
1090
|
end
|
@@ -1313,7 +1093,6 @@ module Stripe
|
|
1313
1093
|
returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::TrialSettings::EndBehavior)
|
1314
1094
|
}
|
1315
1095
|
attr_accessor :end_behavior
|
1316
|
-
|
1317
1096
|
sig {
|
1318
1097
|
params(end_behavior: ::Stripe::SubscriptionSchedule::CreateParams::Phase::TrialSettings::EndBehavior).void
|
1319
1098
|
}
|
@@ -1324,107 +1103,82 @@ module Stripe
|
|
1324
1103
|
returns(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem])
|
1325
1104
|
}
|
1326
1105
|
attr_accessor :add_invoice_items
|
1327
|
-
|
1328
1106
|
# 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).
|
1329
1107
|
sig { returns(Float) }
|
1330
1108
|
attr_accessor :application_fee_percent
|
1331
|
-
|
1332
1109
|
# Automatic tax settings for this phase.
|
1333
1110
|
sig { returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::AutomaticTax) }
|
1334
1111
|
attr_accessor :automatic_tax
|
1335
|
-
|
1336
1112
|
# 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/docs/billing/subscriptions/billing-cycle).
|
1337
1113
|
sig { returns(String) }
|
1338
1114
|
attr_accessor :billing_cycle_anchor
|
1339
|
-
|
1340
1115
|
# 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.
|
1341
1116
|
sig {
|
1342
1117
|
returns(T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::BillingThresholds))
|
1343
1118
|
}
|
1344
1119
|
attr_accessor :billing_thresholds
|
1345
|
-
|
1346
1120
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
|
1347
1121
|
sig { returns(String) }
|
1348
1122
|
attr_accessor :collection_method
|
1349
|
-
|
1350
1123
|
# The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
|
1351
1124
|
sig { returns(String) }
|
1352
1125
|
attr_accessor :coupon
|
1353
|
-
|
1354
1126
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
1355
1127
|
sig { returns(String) }
|
1356
1128
|
attr_accessor :currency
|
1357
|
-
|
1358
1129
|
# 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.
|
1359
1130
|
sig { returns(String) }
|
1360
1131
|
attr_accessor :default_payment_method
|
1361
|
-
|
1362
1132
|
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
|
1363
1133
|
sig { returns(T.nilable(T::Array[String])) }
|
1364
1134
|
attr_accessor :default_tax_rates
|
1365
|
-
|
1366
1135
|
# 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.
|
1367
1136
|
sig { returns(T.nilable(String)) }
|
1368
1137
|
attr_accessor :description
|
1369
|
-
|
1370
1138
|
# The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
|
1371
1139
|
sig {
|
1372
1140
|
returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount]))
|
1373
1141
|
}
|
1374
1142
|
attr_accessor :discounts
|
1375
|
-
|
1376
1143
|
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
|
1377
1144
|
sig { returns(Integer) }
|
1378
1145
|
attr_accessor :end_date
|
1379
|
-
|
1380
1146
|
# All invoices will be billed using the specified settings.
|
1381
1147
|
sig { returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::InvoiceSettings) }
|
1382
1148
|
attr_accessor :invoice_settings
|
1383
|
-
|
1384
1149
|
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
|
1385
1150
|
sig { returns(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item]) }
|
1386
1151
|
attr_accessor :items
|
1387
|
-
|
1388
1152
|
# Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
|
1389
1153
|
sig { returns(Integer) }
|
1390
1154
|
attr_accessor :iterations
|
1391
|
-
|
1392
1155
|
# Set of [key-value pairs](https://stripe.com/docs/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`.
|
1393
1156
|
sig { returns(T::Hash[String, String]) }
|
1394
1157
|
attr_accessor :metadata
|
1395
|
-
|
1396
1158
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
1397
1159
|
sig { returns(String) }
|
1398
1160
|
attr_accessor :on_behalf_of
|
1399
|
-
|
1400
1161
|
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
|
1401
1162
|
sig { returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::PauseCollection) }
|
1402
1163
|
attr_accessor :pause_collection
|
1403
|
-
|
1404
1164
|
# Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. 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 of the current phase.
|
1405
1165
|
sig { returns(String) }
|
1406
1166
|
attr_accessor :proration_behavior
|
1407
|
-
|
1408
1167
|
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
1409
1168
|
sig { returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::TransferData) }
|
1410
1169
|
attr_accessor :transfer_data
|
1411
|
-
|
1412
1170
|
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
1413
1171
|
sig { returns(T::Boolean) }
|
1414
1172
|
attr_accessor :trial
|
1415
|
-
|
1416
1173
|
# Specify trial behavior when crossing phase boundaries
|
1417
1174
|
sig { returns(String) }
|
1418
1175
|
attr_accessor :trial_continuation
|
1419
|
-
|
1420
1176
|
# 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`
|
1421
1177
|
sig { returns(Integer) }
|
1422
1178
|
attr_accessor :trial_end
|
1423
|
-
|
1424
1179
|
# Settings related to subscription trials.
|
1425
1180
|
sig { returns(::Stripe::SubscriptionSchedule::CreateParams::Phase::TrialSettings) }
|
1426
1181
|
attr_accessor :trial_settings
|
1427
|
-
|
1428
1182
|
sig {
|
1429
1183
|
params(add_invoice_items: T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem], application_fee_percent: Float, automatic_tax: ::Stripe::SubscriptionSchedule::CreateParams::Phase::AutomaticTax, billing_cycle_anchor: String, billing_thresholds: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::BillingThresholds), collection_method: String, coupon: String, currency: String, default_payment_method: String, default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), discounts: T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount]), end_date: Integer, invoice_settings: ::Stripe::SubscriptionSchedule::CreateParams::Phase::InvoiceSettings, items: T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item], iterations: Integer, metadata: T::Hash[String, String], on_behalf_of: String, pause_collection: ::Stripe::SubscriptionSchedule::CreateParams::Phase::PauseCollection, proration_behavior: String, transfer_data: ::Stripe::SubscriptionSchedule::CreateParams::Phase::TransferData, trial: T::Boolean, trial_continuation: String, trial_end: Integer, trial_settings: ::Stripe::SubscriptionSchedule::CreateParams::Phase::TrialSettings).void
|
1430
1184
|
}
|
@@ -1460,54 +1214,42 @@ module Stripe
|
|
1460
1214
|
# This is used to determine the number of billing cycles to prebill.
|
1461
1215
|
sig { returns(Integer) }
|
1462
1216
|
attr_accessor :iterations
|
1463
|
-
|
1464
1217
|
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
1465
1218
|
sig { returns(String) }
|
1466
1219
|
attr_accessor :update_behavior
|
1467
|
-
|
1468
1220
|
sig { params(iterations: Integer, update_behavior: String).void }
|
1469
1221
|
def initialize(iterations: nil, update_behavior: nil); end
|
1470
1222
|
end
|
1471
1223
|
# 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.
|
1472
1224
|
sig { returns(String) }
|
1473
1225
|
attr_accessor :billing_behavior
|
1474
|
-
|
1475
1226
|
# The identifier of the customer to create the subscription schedule for.
|
1476
1227
|
sig { returns(String) }
|
1477
1228
|
attr_accessor :customer
|
1478
|
-
|
1479
1229
|
# Object representing the subscription schedule's default settings.
|
1480
1230
|
sig { returns(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings) }
|
1481
1231
|
attr_accessor :default_settings
|
1482
|
-
|
1483
1232
|
# 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.
|
1484
1233
|
sig { returns(String) }
|
1485
1234
|
attr_accessor :end_behavior
|
1486
|
-
|
1487
1235
|
# Specifies which fields in the response should be expanded.
|
1488
1236
|
sig { returns(T::Array[String]) }
|
1489
1237
|
attr_accessor :expand
|
1490
|
-
|
1491
1238
|
# Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
|
1492
1239
|
sig { returns(String) }
|
1493
1240
|
attr_accessor :from_subscription
|
1494
|
-
|
1495
1241
|
# 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`.
|
1496
1242
|
sig { returns(T.nilable(T::Hash[String, String])) }
|
1497
1243
|
attr_accessor :metadata
|
1498
|
-
|
1499
1244
|
# 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.
|
1500
1245
|
sig { returns(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase]) }
|
1501
1246
|
attr_accessor :phases
|
1502
|
-
|
1503
1247
|
# If specified, the invoicing for the given billing cycle iterations will be processed now.
|
1504
1248
|
sig { returns(::Stripe::SubscriptionSchedule::CreateParams::Prebilling) }
|
1505
1249
|
attr_accessor :prebilling
|
1506
|
-
|
1507
1250
|
# When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
|
1508
1251
|
sig { returns(T.any(Integer, String)) }
|
1509
1252
|
attr_accessor :start_date
|
1510
|
-
|
1511
1253
|
sig {
|
1512
1254
|
params(billing_behavior: String, customer: String, default_settings: ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings, end_behavior: String, expand: T::Array[String], from_subscription: String, metadata: T.nilable(T::Hash[String, String]), phases: T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase], prebilling: ::Stripe::SubscriptionSchedule::CreateParams::Prebilling, start_date: T.any(Integer, String)).void
|
1513
1255
|
}
|
@@ -1528,7 +1270,6 @@ module Stripe
|
|
1528
1270
|
# Specifies which fields in the response should be expanded.
|
1529
1271
|
sig { returns(T::Array[String]) }
|
1530
1272
|
attr_accessor :expand
|
1531
|
-
|
1532
1273
|
sig { params(expand: T::Array[String]).void }
|
1533
1274
|
def initialize(expand: nil); end
|
1534
1275
|
end
|
@@ -1539,24 +1280,20 @@ module Stripe
|
|
1539
1280
|
# The connected account being referenced when `type` is `account`.
|
1540
1281
|
sig { returns(String) }
|
1541
1282
|
attr_accessor :account
|
1542
|
-
|
1543
1283
|
# Type of the account referenced in the request.
|
1544
1284
|
sig { returns(String) }
|
1545
1285
|
attr_accessor :type
|
1546
|
-
|
1547
1286
|
sig { params(account: String, type: String).void }
|
1548
1287
|
def initialize(account: nil, type: nil); end
|
1549
1288
|
end
|
1550
1289
|
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
1551
1290
|
sig { returns(T::Boolean) }
|
1552
1291
|
attr_accessor :enabled
|
1553
|
-
|
1554
1292
|
# 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.
|
1555
1293
|
sig {
|
1556
1294
|
returns(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::AutomaticTax::Liability)
|
1557
1295
|
}
|
1558
1296
|
attr_accessor :liability
|
1559
|
-
|
1560
1297
|
sig {
|
1561
1298
|
params(enabled: T::Boolean, liability: ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::AutomaticTax::Liability).void
|
1562
1299
|
}
|
@@ -1566,11 +1303,9 @@ module Stripe
|
|
1566
1303
|
# Monetary threshold that triggers the subscription to advance to a new billing period
|
1567
1304
|
sig { returns(Integer) }
|
1568
1305
|
attr_accessor :amount_gte
|
1569
|
-
|
1570
1306
|
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
|
1571
1307
|
sig { returns(T::Boolean) }
|
1572
1308
|
attr_accessor :reset_billing_cycle_anchor
|
1573
|
-
|
1574
1309
|
sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
|
1575
1310
|
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
|
1576
1311
|
end
|
@@ -1579,28 +1314,23 @@ module Stripe
|
|
1579
1314
|
# The connected account being referenced when `type` is `account`.
|
1580
1315
|
sig { returns(String) }
|
1581
1316
|
attr_accessor :account
|
1582
|
-
|
1583
1317
|
# Type of the account referenced in the request.
|
1584
1318
|
sig { returns(String) }
|
1585
1319
|
attr_accessor :type
|
1586
|
-
|
1587
1320
|
sig { params(account: String, type: String).void }
|
1588
1321
|
def initialize(account: nil, type: nil); end
|
1589
1322
|
end
|
1590
1323
|
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
|
1591
1324
|
sig { returns(T.nilable(T::Array[String])) }
|
1592
1325
|
attr_accessor :account_tax_ids
|
1593
|
-
|
1594
1326
|
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
|
1595
1327
|
sig { returns(Integer) }
|
1596
1328
|
attr_accessor :days_until_due
|
1597
|
-
|
1598
1329
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
1599
1330
|
sig {
|
1600
1331
|
returns(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::InvoiceSettings::Issuer)
|
1601
1332
|
}
|
1602
1333
|
attr_accessor :issuer
|
1603
|
-
|
1604
1334
|
sig {
|
1605
1335
|
params(account_tax_ids: T.nilable(T::Array[String]), days_until_due: Integer, issuer: ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::InvoiceSettings::Issuer).void
|
1606
1336
|
}
|
@@ -1610,60 +1340,48 @@ module Stripe
|
|
1610
1340
|
# 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 destination account. By default, the entire amount is transferred to the destination.
|
1611
1341
|
sig { returns(Float) }
|
1612
1342
|
attr_accessor :amount_percent
|
1613
|
-
|
1614
1343
|
# ID of an existing, connected Stripe account.
|
1615
1344
|
sig { returns(String) }
|
1616
1345
|
attr_accessor :destination
|
1617
|
-
|
1618
1346
|
sig { params(amount_percent: Float, destination: String).void }
|
1619
1347
|
def initialize(amount_percent: nil, destination: nil); end
|
1620
1348
|
end
|
1621
1349
|
# 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).
|
1622
1350
|
sig { returns(Float) }
|
1623
1351
|
attr_accessor :application_fee_percent
|
1624
|
-
|
1625
1352
|
# Default settings for automatic tax computation.
|
1626
1353
|
sig { returns(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::AutomaticTax) }
|
1627
1354
|
attr_accessor :automatic_tax
|
1628
|
-
|
1629
1355
|
# 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/docs/billing/subscriptions/billing-cycle).
|
1630
1356
|
sig { returns(String) }
|
1631
1357
|
attr_accessor :billing_cycle_anchor
|
1632
|
-
|
1633
1358
|
# 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.
|
1634
1359
|
sig {
|
1635
1360
|
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::BillingThresholds))
|
1636
1361
|
}
|
1637
1362
|
attr_accessor :billing_thresholds
|
1638
|
-
|
1639
1363
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
|
1640
1364
|
sig { returns(String) }
|
1641
1365
|
attr_accessor :collection_method
|
1642
|
-
|
1643
1366
|
# 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.
|
1644
1367
|
sig { returns(String) }
|
1645
1368
|
attr_accessor :default_payment_method
|
1646
|
-
|
1647
1369
|
# 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.
|
1648
1370
|
sig { returns(T.nilable(String)) }
|
1649
1371
|
attr_accessor :description
|
1650
|
-
|
1651
1372
|
# All invoices will be billed using the specified settings.
|
1652
1373
|
sig {
|
1653
1374
|
returns(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::InvoiceSettings)
|
1654
1375
|
}
|
1655
1376
|
attr_accessor :invoice_settings
|
1656
|
-
|
1657
1377
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
1658
1378
|
sig { returns(T.nilable(String)) }
|
1659
1379
|
attr_accessor :on_behalf_of
|
1660
|
-
|
1661
1380
|
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
1662
1381
|
sig {
|
1663
1382
|
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::TransferData))
|
1664
1383
|
}
|
1665
1384
|
attr_accessor :transfer_data
|
1666
|
-
|
1667
1385
|
sig {
|
1668
1386
|
params(application_fee_percent: Float, automatic_tax: ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::AutomaticTax, billing_cycle_anchor: String, billing_thresholds: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::BillingThresholds), collection_method: String, default_payment_method: String, description: T.nilable(String), invoice_settings: ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::InvoiceSettings, on_behalf_of: T.nilable(String), transfer_data: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::TransferData)).void
|
1669
1387
|
}
|
@@ -1688,11 +1406,9 @@ module Stripe
|
|
1688
1406
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1689
1407
|
sig { returns(String) }
|
1690
1408
|
attr_accessor :interval
|
1691
|
-
|
1692
1409
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1693
1410
|
sig { returns(Integer) }
|
1694
1411
|
attr_accessor :interval_count
|
1695
|
-
|
1696
1412
|
sig { params(interval: String, interval_count: Integer).void }
|
1697
1413
|
def initialize(interval: nil, interval_count: nil); end
|
1698
1414
|
end
|
@@ -1701,15 +1417,12 @@ module Stripe
|
|
1701
1417
|
returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration)
|
1702
1418
|
}
|
1703
1419
|
attr_accessor :duration
|
1704
|
-
|
1705
1420
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1706
1421
|
sig { returns(Integer) }
|
1707
1422
|
attr_accessor :timestamp
|
1708
|
-
|
1709
1423
|
# The type of calculation made to determine when the discount ends.
|
1710
1424
|
sig { returns(String) }
|
1711
1425
|
attr_accessor :type
|
1712
|
-
|
1713
1426
|
sig {
|
1714
1427
|
params(duration: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
|
1715
1428
|
}
|
@@ -1718,21 +1431,17 @@ module Stripe
|
|
1718
1431
|
# ID of the coupon to create a new discount for.
|
1719
1432
|
sig { returns(String) }
|
1720
1433
|
attr_accessor :coupon
|
1721
|
-
|
1722
1434
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1723
1435
|
sig { returns(String) }
|
1724
1436
|
attr_accessor :discount
|
1725
|
-
|
1726
1437
|
# Details to determine how long the discount should be applied for.
|
1727
1438
|
sig {
|
1728
1439
|
returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd)
|
1729
1440
|
}
|
1730
1441
|
attr_accessor :discount_end
|
1731
|
-
|
1732
1442
|
# ID of the promotion code to create a new discount for.
|
1733
1443
|
sig { returns(String) }
|
1734
1444
|
attr_accessor :promotion_code
|
1735
|
-
|
1736
1445
|
sig {
|
1737
1446
|
params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount::DiscountEnd, promotion_code: String).void
|
1738
1447
|
}
|
@@ -1742,23 +1451,18 @@ module Stripe
|
|
1742
1451
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
1743
1452
|
sig { returns(String) }
|
1744
1453
|
attr_accessor :currency
|
1745
|
-
|
1746
1454
|
# The ID of the product that this price will belong to.
|
1747
1455
|
sig { returns(String) }
|
1748
1456
|
attr_accessor :product
|
1749
|
-
|
1750
1457
|
# Only required if a [default tax behavior](https://stripe.com/docs/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.
|
1751
1458
|
sig { returns(String) }
|
1752
1459
|
attr_accessor :tax_behavior
|
1753
|
-
|
1754
1460
|
# 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.
|
1755
1461
|
sig { returns(Integer) }
|
1756
1462
|
attr_accessor :unit_amount
|
1757
|
-
|
1758
1463
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
1759
1464
|
sig { returns(String) }
|
1760
1465
|
attr_accessor :unit_amount_decimal
|
1761
|
-
|
1762
1466
|
sig {
|
1763
1467
|
params(currency: String, product: String, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
|
1764
1468
|
}
|
@@ -1775,25 +1479,20 @@ module Stripe
|
|
1775
1479
|
returns(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount])
|
1776
1480
|
}
|
1777
1481
|
attr_accessor :discounts
|
1778
|
-
|
1779
1482
|
# The ID of the price object. One of `price` or `price_data` is required.
|
1780
1483
|
sig { returns(String) }
|
1781
1484
|
attr_accessor :price
|
1782
|
-
|
1783
1485
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
1784
1486
|
sig {
|
1785
1487
|
returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::PriceData)
|
1786
1488
|
}
|
1787
1489
|
attr_accessor :price_data
|
1788
|
-
|
1789
1490
|
# Quantity for this item. Defaults to 1.
|
1790
1491
|
sig { returns(Integer) }
|
1791
1492
|
attr_accessor :quantity
|
1792
|
-
|
1793
1493
|
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
|
1794
1494
|
sig { returns(T.nilable(T::Array[String])) }
|
1795
1495
|
attr_accessor :tax_rates
|
1796
|
-
|
1797
1496
|
sig {
|
1798
1497
|
params(discounts: T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::Discount], price: String, price_data: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
|
1799
1498
|
}
|
@@ -1810,24 +1509,20 @@ module Stripe
|
|
1810
1509
|
# The connected account being referenced when `type` is `account`.
|
1811
1510
|
sig { returns(String) }
|
1812
1511
|
attr_accessor :account
|
1813
|
-
|
1814
1512
|
# Type of the account referenced in the request.
|
1815
1513
|
sig { returns(String) }
|
1816
1514
|
attr_accessor :type
|
1817
|
-
|
1818
1515
|
sig { params(account: String, type: String).void }
|
1819
1516
|
def initialize(account: nil, type: nil); end
|
1820
1517
|
end
|
1821
1518
|
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
1822
1519
|
sig { returns(T::Boolean) }
|
1823
1520
|
attr_accessor :enabled
|
1824
|
-
|
1825
1521
|
# 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.
|
1826
1522
|
sig {
|
1827
1523
|
returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AutomaticTax::Liability)
|
1828
1524
|
}
|
1829
1525
|
attr_accessor :liability
|
1830
|
-
|
1831
1526
|
sig {
|
1832
1527
|
params(enabled: T::Boolean, liability: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::AutomaticTax::Liability).void
|
1833
1528
|
}
|
@@ -1837,11 +1532,9 @@ module Stripe
|
|
1837
1532
|
# Monetary threshold that triggers the subscription to advance to a new billing period
|
1838
1533
|
sig { returns(Integer) }
|
1839
1534
|
attr_accessor :amount_gte
|
1840
|
-
|
1841
1535
|
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
|
1842
1536
|
sig { returns(T::Boolean) }
|
1843
1537
|
attr_accessor :reset_billing_cycle_anchor
|
1844
|
-
|
1845
1538
|
sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
|
1846
1539
|
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
|
1847
1540
|
end
|
@@ -1851,11 +1544,9 @@ module Stripe
|
|
1851
1544
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1852
1545
|
sig { returns(String) }
|
1853
1546
|
attr_accessor :interval
|
1854
|
-
|
1855
1547
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1856
1548
|
sig { returns(Integer) }
|
1857
1549
|
attr_accessor :interval_count
|
1858
|
-
|
1859
1550
|
sig { params(interval: String, interval_count: Integer).void }
|
1860
1551
|
def initialize(interval: nil, interval_count: nil); end
|
1861
1552
|
end
|
@@ -1864,15 +1555,12 @@ module Stripe
|
|
1864
1555
|
returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount::DiscountEnd::Duration)
|
1865
1556
|
}
|
1866
1557
|
attr_accessor :duration
|
1867
|
-
|
1868
1558
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1869
1559
|
sig { returns(Integer) }
|
1870
1560
|
attr_accessor :timestamp
|
1871
|
-
|
1872
1561
|
# The type of calculation made to determine when the discount ends.
|
1873
1562
|
sig { returns(String) }
|
1874
1563
|
attr_accessor :type
|
1875
|
-
|
1876
1564
|
sig {
|
1877
1565
|
params(duration: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
|
1878
1566
|
}
|
@@ -1881,21 +1569,17 @@ module Stripe
|
|
1881
1569
|
# ID of the coupon to create a new discount for.
|
1882
1570
|
sig { returns(String) }
|
1883
1571
|
attr_accessor :coupon
|
1884
|
-
|
1885
1572
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1886
1573
|
sig { returns(String) }
|
1887
1574
|
attr_accessor :discount
|
1888
|
-
|
1889
1575
|
# Details to determine how long the discount should be applied for.
|
1890
1576
|
sig {
|
1891
1577
|
returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount::DiscountEnd)
|
1892
1578
|
}
|
1893
1579
|
attr_accessor :discount_end
|
1894
|
-
|
1895
1580
|
# ID of the promotion code to create a new discount for.
|
1896
1581
|
sig { returns(String) }
|
1897
1582
|
attr_accessor :promotion_code
|
1898
|
-
|
1899
1583
|
sig {
|
1900
1584
|
params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount::DiscountEnd, promotion_code: String).void
|
1901
1585
|
}
|
@@ -1906,28 +1590,23 @@ module Stripe
|
|
1906
1590
|
# The connected account being referenced when `type` is `account`.
|
1907
1591
|
sig { returns(String) }
|
1908
1592
|
attr_accessor :account
|
1909
|
-
|
1910
1593
|
# Type of the account referenced in the request.
|
1911
1594
|
sig { returns(String) }
|
1912
1595
|
attr_accessor :type
|
1913
|
-
|
1914
1596
|
sig { params(account: String, type: String).void }
|
1915
1597
|
def initialize(account: nil, type: nil); end
|
1916
1598
|
end
|
1917
1599
|
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
1918
1600
|
sig { returns(T.nilable(T::Array[String])) }
|
1919
1601
|
attr_accessor :account_tax_ids
|
1920
|
-
|
1921
1602
|
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
|
1922
1603
|
sig { returns(Integer) }
|
1923
1604
|
attr_accessor :days_until_due
|
1924
|
-
|
1925
1605
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
1926
1606
|
sig {
|
1927
1607
|
returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::InvoiceSettings::Issuer)
|
1928
1608
|
}
|
1929
1609
|
attr_accessor :issuer
|
1930
|
-
|
1931
1610
|
sig {
|
1932
1611
|
params(account_tax_ids: T.nilable(T::Array[String]), days_until_due: Integer, issuer: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::InvoiceSettings::Issuer).void
|
1933
1612
|
}
|
@@ -1938,7 +1617,6 @@ module Stripe
|
|
1938
1617
|
# 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/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
1939
1618
|
sig { returns(Integer) }
|
1940
1619
|
attr_accessor :usage_gte
|
1941
|
-
|
1942
1620
|
sig { params(usage_gte: Integer).void }
|
1943
1621
|
def initialize(usage_gte: nil); end
|
1944
1622
|
end
|
@@ -1948,11 +1626,9 @@ module Stripe
|
|
1948
1626
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1949
1627
|
sig { returns(String) }
|
1950
1628
|
attr_accessor :interval
|
1951
|
-
|
1952
1629
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1953
1630
|
sig { returns(Integer) }
|
1954
1631
|
attr_accessor :interval_count
|
1955
|
-
|
1956
1632
|
sig { params(interval: String, interval_count: Integer).void }
|
1957
1633
|
def initialize(interval: nil, interval_count: nil); end
|
1958
1634
|
end
|
@@ -1961,15 +1637,12 @@ module Stripe
|
|
1961
1637
|
returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount::DiscountEnd::Duration)
|
1962
1638
|
}
|
1963
1639
|
attr_accessor :duration
|
1964
|
-
|
1965
1640
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1966
1641
|
sig { returns(Integer) }
|
1967
1642
|
attr_accessor :timestamp
|
1968
|
-
|
1969
1643
|
# The type of calculation made to determine when the discount ends.
|
1970
1644
|
sig { returns(String) }
|
1971
1645
|
attr_accessor :type
|
1972
|
-
|
1973
1646
|
sig {
|
1974
1647
|
params(duration: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
|
1975
1648
|
}
|
@@ -1978,21 +1651,17 @@ module Stripe
|
|
1978
1651
|
# ID of the coupon to create a new discount for.
|
1979
1652
|
sig { returns(String) }
|
1980
1653
|
attr_accessor :coupon
|
1981
|
-
|
1982
1654
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1983
1655
|
sig { returns(String) }
|
1984
1656
|
attr_accessor :discount
|
1985
|
-
|
1986
1657
|
# Details to determine how long the discount should be applied for.
|
1987
1658
|
sig {
|
1988
1659
|
returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount::DiscountEnd)
|
1989
1660
|
}
|
1990
1661
|
attr_accessor :discount_end
|
1991
|
-
|
1992
1662
|
# ID of the promotion code to create a new discount for.
|
1993
1663
|
sig { returns(String) }
|
1994
1664
|
attr_accessor :promotion_code
|
1995
|
-
|
1996
1665
|
sig {
|
1997
1666
|
params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount::DiscountEnd, promotion_code: String).void
|
1998
1667
|
}
|
@@ -2003,40 +1672,32 @@ module Stripe
|
|
2003
1672
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
2004
1673
|
sig { returns(String) }
|
2005
1674
|
attr_accessor :interval
|
2006
|
-
|
2007
1675
|
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
2008
1676
|
sig { returns(Integer) }
|
2009
1677
|
attr_accessor :interval_count
|
2010
|
-
|
2011
1678
|
sig { params(interval: String, interval_count: Integer).void }
|
2012
1679
|
def initialize(interval: nil, interval_count: nil); end
|
2013
1680
|
end
|
2014
1681
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
2015
1682
|
sig { returns(String) }
|
2016
1683
|
attr_accessor :currency
|
2017
|
-
|
2018
1684
|
# The ID of the product that this price will belong to.
|
2019
1685
|
sig { returns(String) }
|
2020
1686
|
attr_accessor :product
|
2021
|
-
|
2022
1687
|
# The recurring components of a price such as `interval` and `interval_count`.
|
2023
1688
|
sig {
|
2024
1689
|
returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::PriceData::Recurring)
|
2025
1690
|
}
|
2026
1691
|
attr_accessor :recurring
|
2027
|
-
|
2028
1692
|
# Only required if a [default tax behavior](https://stripe.com/docs/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.
|
2029
1693
|
sig { returns(String) }
|
2030
1694
|
attr_accessor :tax_behavior
|
2031
|
-
|
2032
1695
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
2033
1696
|
sig { returns(Integer) }
|
2034
1697
|
attr_accessor :unit_amount
|
2035
|
-
|
2036
1698
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
2037
1699
|
sig { returns(String) }
|
2038
1700
|
attr_accessor :unit_amount_decimal
|
2039
|
-
|
2040
1701
|
sig {
|
2041
1702
|
params(currency: String, product: String, recurring: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
|
2042
1703
|
}
|
@@ -2053,11 +1714,9 @@ module Stripe
|
|
2053
1714
|
# 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.
|
2054
1715
|
sig { returns(T::Array[String]) }
|
2055
1716
|
attr_accessor :converts_to
|
2056
|
-
|
2057
1717
|
# Determines the type of trial for this item.
|
2058
1718
|
sig { returns(String) }
|
2059
1719
|
attr_accessor :type
|
2060
|
-
|
2061
1720
|
sig { params(converts_to: T::Array[String], type: String).void }
|
2062
1721
|
def initialize(converts_to: nil, type: nil); end
|
2063
1722
|
end
|
@@ -2066,41 +1725,32 @@ module Stripe
|
|
2066
1725
|
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::BillingThresholds))
|
2067
1726
|
}
|
2068
1727
|
attr_accessor :billing_thresholds
|
2069
|
-
|
2070
1728
|
# The coupons to redeem into discounts for the subscription item.
|
2071
1729
|
sig {
|
2072
1730
|
returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount]))
|
2073
1731
|
}
|
2074
1732
|
attr_accessor :discounts
|
2075
|
-
|
2076
1733
|
# Set of [key-value pairs](https://stripe.com/docs/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`.
|
2077
1734
|
sig { returns(T::Hash[String, String]) }
|
2078
1735
|
attr_accessor :metadata
|
2079
|
-
|
2080
1736
|
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
|
2081
1737
|
sig { returns(String) }
|
2082
1738
|
attr_accessor :plan
|
2083
|
-
|
2084
1739
|
# The ID of the price object.
|
2085
1740
|
sig { returns(String) }
|
2086
1741
|
attr_accessor :price
|
2087
|
-
|
2088
1742
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
|
2089
1743
|
sig { returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::PriceData) }
|
2090
1744
|
attr_accessor :price_data
|
2091
|
-
|
2092
1745
|
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
|
2093
1746
|
sig { returns(Integer) }
|
2094
1747
|
attr_accessor :quantity
|
2095
|
-
|
2096
1748
|
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
2097
1749
|
sig { returns(T.nilable(T::Array[String])) }
|
2098
1750
|
attr_accessor :tax_rates
|
2099
|
-
|
2100
1751
|
# Options that configure the trial on the subscription item.
|
2101
1752
|
sig { returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Trial) }
|
2102
1753
|
attr_accessor :trial
|
2103
|
-
|
2104
1754
|
sig {
|
2105
1755
|
params(billing_thresholds: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::BillingThresholds), discounts: T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount]), metadata: T::Hash[String, String], plan: String, price: String, price_data: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String]), trial: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Trial).void
|
2106
1756
|
}
|
@@ -2120,7 +1770,6 @@ module Stripe
|
|
2120
1770
|
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
2121
1771
|
sig { returns(String) }
|
2122
1772
|
attr_accessor :behavior
|
2123
|
-
|
2124
1773
|
sig { params(behavior: String).void }
|
2125
1774
|
def initialize(behavior: nil); end
|
2126
1775
|
end
|
@@ -2128,11 +1777,9 @@ module Stripe
|
|
2128
1777
|
# 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 destination account. By default, the entire amount is transferred to the destination.
|
2129
1778
|
sig { returns(Float) }
|
2130
1779
|
attr_accessor :amount_percent
|
2131
|
-
|
2132
1780
|
# ID of an existing, connected Stripe account.
|
2133
1781
|
sig { returns(String) }
|
2134
1782
|
attr_accessor :destination
|
2135
|
-
|
2136
1783
|
sig { params(amount_percent: Float, destination: String).void }
|
2137
1784
|
def initialize(amount_percent: nil, destination: nil); end
|
2138
1785
|
end
|
@@ -2141,7 +1788,6 @@ module Stripe
|
|
2141
1788
|
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
2142
1789
|
sig { returns(String) }
|
2143
1790
|
attr_accessor :prorate_up_front
|
2144
|
-
|
2145
1791
|
sig { params(prorate_up_front: String).void }
|
2146
1792
|
def initialize(prorate_up_front: nil); end
|
2147
1793
|
end
|
@@ -2150,7 +1796,6 @@ module Stripe
|
|
2150
1796
|
returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TrialSettings::EndBehavior)
|
2151
1797
|
}
|
2152
1798
|
attr_accessor :end_behavior
|
2153
|
-
|
2154
1799
|
sig {
|
2155
1800
|
params(end_behavior: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::TrialSettings::EndBehavior).void
|
2156
1801
|
}
|
@@ -2161,111 +1806,85 @@ module Stripe
|
|
2161
1806
|
returns(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem])
|
2162
1807
|
}
|
2163
1808
|
attr_accessor :add_invoice_items
|
2164
|
-
|
2165
1809
|
# 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).
|
2166
1810
|
sig { returns(Float) }
|
2167
1811
|
attr_accessor :application_fee_percent
|
2168
|
-
|
2169
1812
|
# Automatic tax settings for this phase.
|
2170
1813
|
sig { returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AutomaticTax) }
|
2171
1814
|
attr_accessor :automatic_tax
|
2172
|
-
|
2173
1815
|
# 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/docs/billing/subscriptions/billing-cycle).
|
2174
1816
|
sig { returns(String) }
|
2175
1817
|
attr_accessor :billing_cycle_anchor
|
2176
|
-
|
2177
1818
|
# 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.
|
2178
1819
|
sig {
|
2179
1820
|
returns(T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::BillingThresholds))
|
2180
1821
|
}
|
2181
1822
|
attr_accessor :billing_thresholds
|
2182
|
-
|
2183
1823
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
|
2184
1824
|
sig { returns(String) }
|
2185
1825
|
attr_accessor :collection_method
|
2186
|
-
|
2187
1826
|
# The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
|
2188
1827
|
sig { returns(String) }
|
2189
1828
|
attr_accessor :coupon
|
2190
|
-
|
2191
1829
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
2192
1830
|
sig { returns(String) }
|
2193
1831
|
attr_accessor :currency
|
2194
|
-
|
2195
1832
|
# 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.
|
2196
1833
|
sig { returns(String) }
|
2197
1834
|
attr_accessor :default_payment_method
|
2198
|
-
|
2199
1835
|
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
|
2200
1836
|
sig { returns(T.nilable(T::Array[String])) }
|
2201
1837
|
attr_accessor :default_tax_rates
|
2202
|
-
|
2203
1838
|
# 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.
|
2204
1839
|
sig { returns(T.nilable(String)) }
|
2205
1840
|
attr_accessor :description
|
2206
|
-
|
2207
1841
|
# The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
|
2208
1842
|
sig {
|
2209
1843
|
returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount]))
|
2210
1844
|
}
|
2211
1845
|
attr_accessor :discounts
|
2212
|
-
|
2213
1846
|
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
|
2214
1847
|
sig { returns(T.any(Integer, String)) }
|
2215
1848
|
attr_accessor :end_date
|
2216
|
-
|
2217
1849
|
# All invoices will be billed using the specified settings.
|
2218
1850
|
sig { returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::InvoiceSettings) }
|
2219
1851
|
attr_accessor :invoice_settings
|
2220
|
-
|
2221
1852
|
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
|
2222
1853
|
sig { returns(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item]) }
|
2223
1854
|
attr_accessor :items
|
2224
|
-
|
2225
1855
|
# Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
|
2226
1856
|
sig { returns(Integer) }
|
2227
1857
|
attr_accessor :iterations
|
2228
|
-
|
2229
1858
|
# Set of [key-value pairs](https://stripe.com/docs/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`.
|
2230
1859
|
sig { returns(T::Hash[String, String]) }
|
2231
1860
|
attr_accessor :metadata
|
2232
|
-
|
2233
1861
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
2234
1862
|
sig { returns(String) }
|
2235
1863
|
attr_accessor :on_behalf_of
|
2236
|
-
|
2237
1864
|
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
|
2238
1865
|
sig { returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::PauseCollection) }
|
2239
1866
|
attr_accessor :pause_collection
|
2240
|
-
|
2241
1867
|
# Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. 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 of the current phase.
|
2242
1868
|
sig { returns(String) }
|
2243
1869
|
attr_accessor :proration_behavior
|
2244
|
-
|
2245
1870
|
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
|
2246
1871
|
sig { returns(T.any(Integer, String)) }
|
2247
1872
|
attr_accessor :start_date
|
2248
|
-
|
2249
1873
|
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
2250
1874
|
sig { returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TransferData) }
|
2251
1875
|
attr_accessor :transfer_data
|
2252
|
-
|
2253
1876
|
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
2254
1877
|
sig { returns(T::Boolean) }
|
2255
1878
|
attr_accessor :trial
|
2256
|
-
|
2257
1879
|
# Specify trial behavior when crossing phase boundaries
|
2258
1880
|
sig { returns(String) }
|
2259
1881
|
attr_accessor :trial_continuation
|
2260
|
-
|
2261
1882
|
# 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`
|
2262
1883
|
sig { returns(T.any(Integer, String)) }
|
2263
1884
|
attr_accessor :trial_end
|
2264
|
-
|
2265
1885
|
# Settings related to subscription trials.
|
2266
1886
|
sig { returns(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TrialSettings) }
|
2267
1887
|
attr_accessor :trial_settings
|
2268
|
-
|
2269
1888
|
sig {
|
2270
1889
|
params(add_invoice_items: T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem], application_fee_percent: Float, automatic_tax: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::AutomaticTax, billing_cycle_anchor: String, billing_thresholds: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::BillingThresholds), collection_method: String, coupon: String, currency: String, default_payment_method: String, default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), discounts: T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount]), end_date: T.any(Integer, String), invoice_settings: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::InvoiceSettings, items: T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item], iterations: Integer, metadata: T::Hash[String, String], on_behalf_of: String, pause_collection: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::PauseCollection, proration_behavior: String, start_date: T.any(Integer, String), transfer_data: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::TransferData, trial: T::Boolean, trial_continuation: String, trial_end: T.any(Integer, String), trial_settings: ::Stripe::SubscriptionSchedule::UpdateParams::Phase::TrialSettings).void
|
2271
1890
|
}
|
@@ -2302,46 +1921,36 @@ module Stripe
|
|
2302
1921
|
# This is used to determine the number of billing cycles to prebill.
|
2303
1922
|
sig { returns(Integer) }
|
2304
1923
|
attr_accessor :iterations
|
2305
|
-
|
2306
1924
|
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
2307
1925
|
sig { returns(String) }
|
2308
1926
|
attr_accessor :update_behavior
|
2309
|
-
|
2310
1927
|
sig { params(iterations: Integer, update_behavior: String).void }
|
2311
1928
|
def initialize(iterations: nil, update_behavior: nil); end
|
2312
1929
|
end
|
2313
1930
|
# 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.
|
2314
1931
|
sig { returns(String) }
|
2315
1932
|
attr_accessor :billing_behavior
|
2316
|
-
|
2317
1933
|
# Object representing the subscription schedule's default settings.
|
2318
1934
|
sig { returns(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings) }
|
2319
1935
|
attr_accessor :default_settings
|
2320
|
-
|
2321
1936
|
# 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.
|
2322
1937
|
sig { returns(String) }
|
2323
1938
|
attr_accessor :end_behavior
|
2324
|
-
|
2325
1939
|
# Specifies which fields in the response should be expanded.
|
2326
1940
|
sig { returns(T::Array[String]) }
|
2327
1941
|
attr_accessor :expand
|
2328
|
-
|
2329
1942
|
# 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`.
|
2330
1943
|
sig { returns(T.nilable(T::Hash[String, String])) }
|
2331
1944
|
attr_accessor :metadata
|
2332
|
-
|
2333
1945
|
# List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.
|
2334
1946
|
sig { returns(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase]) }
|
2335
1947
|
attr_accessor :phases
|
2336
|
-
|
2337
1948
|
# If specified, the invoicing for the given billing cycle iterations will be processed now.
|
2338
1949
|
sig { returns(::Stripe::SubscriptionSchedule::UpdateParams::Prebilling) }
|
2339
1950
|
attr_accessor :prebilling
|
2340
|
-
|
2341
1951
|
# If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.
|
2342
1952
|
sig { returns(String) }
|
2343
1953
|
attr_accessor :proration_behavior
|
2344
|
-
|
2345
1954
|
sig {
|
2346
1955
|
params(billing_behavior: String, default_settings: ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings, end_behavior: String, expand: T::Array[String], metadata: T.nilable(T::Hash[String, String]), phases: T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase], prebilling: ::Stripe::SubscriptionSchedule::UpdateParams::Prebilling, proration_behavior: String).void
|
2347
1956
|
}
|
@@ -2363,7 +1972,6 @@ module Stripe
|
|
2363
1972
|
# The ID of a specific discount.
|
2364
1973
|
sig { returns(String) }
|
2365
1974
|
attr_accessor :discount
|
2366
|
-
|
2367
1975
|
sig { params(discount: String).void }
|
2368
1976
|
def initialize(discount: nil); end
|
2369
1977
|
end
|
@@ -2371,11 +1979,9 @@ module Stripe
|
|
2371
1979
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2372
1980
|
sig { returns(String) }
|
2373
1981
|
attr_accessor :interval
|
2374
|
-
|
2375
1982
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2376
1983
|
sig { returns(Integer) }
|
2377
1984
|
attr_accessor :interval_count
|
2378
|
-
|
2379
1985
|
sig { params(interval: String, interval_count: Integer).void }
|
2380
1986
|
def initialize(interval: nil, interval_count: nil); end
|
2381
1987
|
end
|
@@ -2384,21 +1990,17 @@ module Stripe
|
|
2384
1990
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd::DiscountEnd)
|
2385
1991
|
}
|
2386
1992
|
attr_accessor :discount_end
|
2387
|
-
|
2388
1993
|
# Time span for the amendment starting from the `amendment_start`.
|
2389
1994
|
sig {
|
2390
1995
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd::Duration)
|
2391
1996
|
}
|
2392
1997
|
attr_accessor :duration
|
2393
|
-
|
2394
1998
|
# A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
2395
1999
|
sig { returns(Integer) }
|
2396
2000
|
attr_accessor :timestamp
|
2397
|
-
|
2398
2001
|
# Select one of three ways to pass the `amendment_end`.
|
2399
2002
|
sig { returns(String) }
|
2400
2003
|
attr_accessor :type
|
2401
|
-
|
2402
2004
|
sig {
|
2403
2005
|
params(discount_end: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd::DiscountEnd, duration: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd::Duration, timestamp: Integer, type: String).void
|
2404
2006
|
}
|
@@ -2409,7 +2011,6 @@ module Stripe
|
|
2409
2011
|
# 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.
|
2410
2012
|
sig { returns(Integer) }
|
2411
2013
|
attr_accessor :index
|
2412
|
-
|
2413
2014
|
sig { params(index: Integer).void }
|
2414
2015
|
def initialize(index: nil); end
|
2415
2016
|
end
|
@@ -2417,7 +2018,6 @@ module Stripe
|
|
2417
2018
|
# The ID of a specific discount.
|
2418
2019
|
sig { returns(String) }
|
2419
2020
|
attr_accessor :discount
|
2420
|
-
|
2421
2021
|
sig { params(discount: String).void }
|
2422
2022
|
def initialize(discount: nil); end
|
2423
2023
|
end
|
@@ -2426,21 +2026,17 @@ module Stripe
|
|
2426
2026
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart::AmendmentEnd)
|
2427
2027
|
}
|
2428
2028
|
attr_accessor :amendment_end
|
2429
|
-
|
2430
2029
|
# Use the `end` time of a given discount.
|
2431
2030
|
sig {
|
2432
2031
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart::DiscountEnd)
|
2433
2032
|
}
|
2434
2033
|
attr_accessor :discount_end
|
2435
|
-
|
2436
2034
|
# A precise Unix timestamp for the amendment to start.
|
2437
2035
|
sig { returns(Integer) }
|
2438
2036
|
attr_accessor :timestamp
|
2439
|
-
|
2440
2037
|
# Select one of three ways to pass the `amendment_start`.
|
2441
2038
|
sig { returns(String) }
|
2442
2039
|
attr_accessor :type
|
2443
|
-
|
2444
2040
|
sig {
|
2445
2041
|
params(amendment_end: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart::AmendmentEnd, discount_end: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart::DiscountEnd, timestamp: Integer, type: String).void
|
2446
2042
|
}
|
@@ -2452,32 +2048,26 @@ module Stripe
|
|
2452
2048
|
# The type of calculation made to determine when the discount ends.
|
2453
2049
|
sig { returns(String) }
|
2454
2050
|
attr_accessor :type
|
2455
|
-
|
2456
2051
|
sig { params(type: String).void }
|
2457
2052
|
def initialize(type: nil); end
|
2458
2053
|
end
|
2459
2054
|
# The coupon code to redeem.
|
2460
2055
|
sig { returns(String) }
|
2461
2056
|
attr_accessor :coupon
|
2462
|
-
|
2463
2057
|
# An ID of an existing discount for a coupon that was already redeemed.
|
2464
2058
|
sig { returns(String) }
|
2465
2059
|
attr_accessor :discount
|
2466
|
-
|
2467
2060
|
# Details to determine how long the discount should be applied for.
|
2468
2061
|
sig {
|
2469
2062
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Add::DiscountEnd)
|
2470
2063
|
}
|
2471
2064
|
attr_accessor :discount_end
|
2472
|
-
|
2473
2065
|
# 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.
|
2474
2066
|
sig { returns(Integer) }
|
2475
2067
|
attr_accessor :index
|
2476
|
-
|
2477
2068
|
# The promotion code to redeem.
|
2478
2069
|
sig { returns(String) }
|
2479
2070
|
attr_accessor :promotion_code
|
2480
|
-
|
2481
2071
|
sig {
|
2482
2072
|
params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Add::DiscountEnd, index: Integer, promotion_code: String).void
|
2483
2073
|
}
|
@@ -2493,15 +2083,12 @@ module Stripe
|
|
2493
2083
|
# The coupon code to remove from the `discounts` array.
|
2494
2084
|
sig { returns(String) }
|
2495
2085
|
attr_accessor :coupon
|
2496
|
-
|
2497
2086
|
# The ID of a discount to remove from the `discounts` array.
|
2498
2087
|
sig { returns(String) }
|
2499
2088
|
attr_accessor :discount
|
2500
|
-
|
2501
2089
|
# The ID of a promotion code to remove from the `discounts` array.
|
2502
2090
|
sig { returns(String) }
|
2503
2091
|
attr_accessor :promotion_code
|
2504
|
-
|
2505
2092
|
sig { params(coupon: String, discount: String, promotion_code: String).void }
|
2506
2093
|
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
|
2507
2094
|
end
|
@@ -2509,15 +2096,12 @@ module Stripe
|
|
2509
2096
|
# The coupon code to replace the `discounts` array with.
|
2510
2097
|
sig { returns(String) }
|
2511
2098
|
attr_accessor :coupon
|
2512
|
-
|
2513
2099
|
# An ID of an existing discount to replace the `discounts` array with.
|
2514
2100
|
sig { returns(String) }
|
2515
2101
|
attr_accessor :discount
|
2516
|
-
|
2517
2102
|
# An ID of an existing promotion code to replace the `discounts` array with.
|
2518
2103
|
sig { returns(String) }
|
2519
2104
|
attr_accessor :promotion_code
|
2520
|
-
|
2521
2105
|
sig { params(coupon: String, discount: String, promotion_code: String).void }
|
2522
2106
|
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
|
2523
2107
|
end
|
@@ -2526,23 +2110,19 @@ module Stripe
|
|
2526
2110
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Add)
|
2527
2111
|
}
|
2528
2112
|
attr_accessor :add
|
2529
|
-
|
2530
2113
|
# Details of the discount to remove.
|
2531
2114
|
sig {
|
2532
2115
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Remove)
|
2533
2116
|
}
|
2534
2117
|
attr_accessor :remove
|
2535
|
-
|
2536
2118
|
# Details of the discount to replace the existing discounts with.
|
2537
2119
|
sig {
|
2538
2120
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Set)
|
2539
2121
|
}
|
2540
2122
|
attr_accessor :set
|
2541
|
-
|
2542
2123
|
# Determines the type of discount action.
|
2543
2124
|
sig { returns(String) }
|
2544
2125
|
attr_accessor :type
|
2545
|
-
|
2546
2126
|
sig {
|
2547
2127
|
params(add: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Add, remove: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Remove, set: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction::Set, type: String).void
|
2548
2128
|
}
|
@@ -2556,11 +2136,9 @@ module Stripe
|
|
2556
2136
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2557
2137
|
sig { returns(String) }
|
2558
2138
|
attr_accessor :interval
|
2559
|
-
|
2560
2139
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2561
2140
|
sig { returns(Integer) }
|
2562
2141
|
attr_accessor :interval_count
|
2563
|
-
|
2564
2142
|
sig { params(interval: String, interval_count: Integer).void }
|
2565
2143
|
def initialize(interval: nil, interval_count: nil); end
|
2566
2144
|
end
|
@@ -2569,15 +2147,12 @@ module Stripe
|
|
2569
2147
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration)
|
2570
2148
|
}
|
2571
2149
|
attr_accessor :duration
|
2572
|
-
|
2573
2150
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2574
2151
|
sig { returns(Integer) }
|
2575
2152
|
attr_accessor :timestamp
|
2576
|
-
|
2577
2153
|
# The type of calculation made to determine when the discount ends.
|
2578
2154
|
sig { returns(String) }
|
2579
2155
|
attr_accessor :type
|
2580
|
-
|
2581
2156
|
sig {
|
2582
2157
|
params(duration: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
|
2583
2158
|
}
|
@@ -2586,21 +2161,17 @@ module Stripe
|
|
2586
2161
|
# ID of the coupon to create a new discount for.
|
2587
2162
|
sig { returns(String) }
|
2588
2163
|
attr_accessor :coupon
|
2589
|
-
|
2590
2164
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2591
2165
|
sig { returns(String) }
|
2592
2166
|
attr_accessor :discount
|
2593
|
-
|
2594
2167
|
# Details to determine how long the discount should be applied for.
|
2595
2168
|
sig {
|
2596
2169
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd)
|
2597
2170
|
}
|
2598
2171
|
attr_accessor :discount_end
|
2599
|
-
|
2600
2172
|
# ID of the promotion code to create a new discount for.
|
2601
2173
|
sig { returns(String) }
|
2602
2174
|
attr_accessor :promotion_code
|
2603
|
-
|
2604
2175
|
sig {
|
2605
2176
|
params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount::DiscountEnd, promotion_code: String).void
|
2606
2177
|
}
|
@@ -2615,11 +2186,9 @@ module Stripe
|
|
2615
2186
|
# 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.
|
2616
2187
|
sig { returns(T::Array[String]) }
|
2617
2188
|
attr_accessor :converts_to
|
2618
|
-
|
2619
2189
|
# Determines the type of trial for this item.
|
2620
2190
|
sig { returns(String) }
|
2621
2191
|
attr_accessor :type
|
2622
|
-
|
2623
2192
|
sig { params(converts_to: T::Array[String], type: String).void }
|
2624
2193
|
def initialize(converts_to: nil, type: nil); end
|
2625
2194
|
end
|
@@ -2628,29 +2197,23 @@ module Stripe
|
|
2628
2197
|
returns(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount])
|
2629
2198
|
}
|
2630
2199
|
attr_accessor :discounts
|
2631
|
-
|
2632
2200
|
# 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`.
|
2633
2201
|
sig { returns(T::Hash[String, String]) }
|
2634
2202
|
attr_accessor :metadata
|
2635
|
-
|
2636
2203
|
# The ID of the price object.
|
2637
2204
|
sig { returns(String) }
|
2638
2205
|
attr_accessor :price
|
2639
|
-
|
2640
2206
|
# Quantity for this item.
|
2641
2207
|
sig { returns(Integer) }
|
2642
2208
|
attr_accessor :quantity
|
2643
|
-
|
2644
2209
|
# 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`.
|
2645
2210
|
sig { returns(T::Array[String]) }
|
2646
2211
|
attr_accessor :tax_rates
|
2647
|
-
|
2648
2212
|
# Options that configure the trial on the subscription item.
|
2649
2213
|
sig {
|
2650
2214
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Trial)
|
2651
2215
|
}
|
2652
2216
|
attr_accessor :trial
|
2653
|
-
|
2654
2217
|
sig {
|
2655
2218
|
params(discounts: T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Discount], metadata: T::Hash[String, String], price: String, quantity: Integer, tax_rates: T::Array[String], trial: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add::Trial).void
|
2656
2219
|
}
|
@@ -2667,7 +2230,6 @@ module Stripe
|
|
2667
2230
|
# ID of a price to remove.
|
2668
2231
|
sig { returns(String) }
|
2669
2232
|
attr_accessor :price
|
2670
|
-
|
2671
2233
|
sig { params(price: String).void }
|
2672
2234
|
def initialize(price: nil); end
|
2673
2235
|
end
|
@@ -2678,11 +2240,9 @@ module Stripe
|
|
2678
2240
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2679
2241
|
sig { returns(String) }
|
2680
2242
|
attr_accessor :interval
|
2681
|
-
|
2682
2243
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2683
2244
|
sig { returns(Integer) }
|
2684
2245
|
attr_accessor :interval_count
|
2685
|
-
|
2686
2246
|
sig { params(interval: String, interval_count: Integer).void }
|
2687
2247
|
def initialize(interval: nil, interval_count: nil); end
|
2688
2248
|
end
|
@@ -2691,15 +2251,12 @@ module Stripe
|
|
2691
2251
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration)
|
2692
2252
|
}
|
2693
2253
|
attr_accessor :duration
|
2694
|
-
|
2695
2254
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2696
2255
|
sig { returns(Integer) }
|
2697
2256
|
attr_accessor :timestamp
|
2698
|
-
|
2699
2257
|
# The type of calculation made to determine when the discount ends.
|
2700
2258
|
sig { returns(String) }
|
2701
2259
|
attr_accessor :type
|
2702
|
-
|
2703
2260
|
sig {
|
2704
2261
|
params(duration: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
|
2705
2262
|
}
|
@@ -2708,21 +2265,17 @@ module Stripe
|
|
2708
2265
|
# ID of the coupon to create a new discount for.
|
2709
2266
|
sig { returns(String) }
|
2710
2267
|
attr_accessor :coupon
|
2711
|
-
|
2712
2268
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2713
2269
|
sig { returns(String) }
|
2714
2270
|
attr_accessor :discount
|
2715
|
-
|
2716
2271
|
# Details to determine how long the discount should be applied for.
|
2717
2272
|
sig {
|
2718
2273
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd)
|
2719
2274
|
}
|
2720
2275
|
attr_accessor :discount_end
|
2721
|
-
|
2722
2276
|
# ID of the promotion code to create a new discount for.
|
2723
2277
|
sig { returns(String) }
|
2724
2278
|
attr_accessor :promotion_code
|
2725
|
-
|
2726
2279
|
sig {
|
2727
2280
|
params(coupon: String, discount: String, discount_end: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount::DiscountEnd, promotion_code: String).void
|
2728
2281
|
}
|
@@ -2737,11 +2290,9 @@ module Stripe
|
|
2737
2290
|
# 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.
|
2738
2291
|
sig { returns(T::Array[String]) }
|
2739
2292
|
attr_accessor :converts_to
|
2740
|
-
|
2741
2293
|
# Determines the type of trial for this item.
|
2742
2294
|
sig { returns(String) }
|
2743
2295
|
attr_accessor :type
|
2744
|
-
|
2745
2296
|
sig { params(converts_to: T::Array[String], type: String).void }
|
2746
2297
|
def initialize(converts_to: nil, type: nil); end
|
2747
2298
|
end
|
@@ -2750,29 +2301,23 @@ module Stripe
|
|
2750
2301
|
returns(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount])
|
2751
2302
|
}
|
2752
2303
|
attr_accessor :discounts
|
2753
|
-
|
2754
2304
|
# 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`.
|
2755
2305
|
sig { returns(T::Hash[String, String]) }
|
2756
2306
|
attr_accessor :metadata
|
2757
|
-
|
2758
2307
|
# The ID of the price object.
|
2759
2308
|
sig { returns(String) }
|
2760
2309
|
attr_accessor :price
|
2761
|
-
|
2762
2310
|
# 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`.
|
2763
2311
|
sig { returns(Integer) }
|
2764
2312
|
attr_accessor :quantity
|
2765
|
-
|
2766
2313
|
# 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`.
|
2767
2314
|
sig { returns(T::Array[String]) }
|
2768
2315
|
attr_accessor :tax_rates
|
2769
|
-
|
2770
2316
|
# 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`.
|
2771
2317
|
sig {
|
2772
2318
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Trial)
|
2773
2319
|
}
|
2774
2320
|
attr_accessor :trial
|
2775
|
-
|
2776
2321
|
sig {
|
2777
2322
|
params(discounts: T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Discount], metadata: T::Hash[String, String], price: String, quantity: Integer, tax_rates: T::Array[String], trial: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set::Trial).void
|
2778
2323
|
}
|
@@ -2788,21 +2333,17 @@ module Stripe
|
|
2788
2333
|
# 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.
|
2789
2334
|
sig { returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add) }
|
2790
2335
|
attr_accessor :add
|
2791
|
-
|
2792
2336
|
# Details of the subscription item to remove.
|
2793
2337
|
sig {
|
2794
2338
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Remove)
|
2795
2339
|
}
|
2796
2340
|
attr_accessor :remove
|
2797
|
-
|
2798
2341
|
# 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.
|
2799
2342
|
sig { returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set) }
|
2800
2343
|
attr_accessor :set
|
2801
|
-
|
2802
2344
|
# Determines the type of item action.
|
2803
2345
|
sig { returns(String) }
|
2804
2346
|
attr_accessor :type
|
2805
|
-
|
2806
2347
|
sig {
|
2807
2348
|
params(add: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Add, remove: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Remove, set: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction::Set, type: String).void
|
2808
2349
|
}
|
@@ -2812,19 +2353,15 @@ module Stripe
|
|
2812
2353
|
# Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
2813
2354
|
sig { returns(T::Hash[String, String]) }
|
2814
2355
|
attr_accessor :add
|
2815
|
-
|
2816
2356
|
# Keys to remove from schedule phase metadata.
|
2817
2357
|
sig { returns(T::Array[String]) }
|
2818
2358
|
attr_accessor :remove
|
2819
|
-
|
2820
2359
|
# Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
2821
2360
|
sig { returns(T.nilable(T::Hash[String, String])) }
|
2822
2361
|
attr_accessor :set
|
2823
|
-
|
2824
2362
|
# Select one of three ways to update phase-level `metadata` on subscription schedules.
|
2825
2363
|
sig { returns(String) }
|
2826
2364
|
attr_accessor :type
|
2827
|
-
|
2828
2365
|
sig {
|
2829
2366
|
params(add: T::Hash[String, String], remove: T::Array[String], set: T.nilable(T::Hash[String, String]), type: String).void
|
2830
2367
|
}
|
@@ -2835,7 +2372,6 @@ module Stripe
|
|
2835
2372
|
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
2836
2373
|
sig { returns(String) }
|
2837
2374
|
attr_accessor :behavior
|
2838
|
-
|
2839
2375
|
sig { params(behavior: String).void }
|
2840
2376
|
def initialize(behavior: nil); end
|
2841
2377
|
end
|
@@ -2844,11 +2380,9 @@ module Stripe
|
|
2844
2380
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::SetPauseCollection::Set)
|
2845
2381
|
}
|
2846
2382
|
attr_accessor :set
|
2847
|
-
|
2848
2383
|
# Determines the type of the pause_collection amendment.
|
2849
2384
|
sig { returns(String) }
|
2850
2385
|
attr_accessor :type
|
2851
|
-
|
2852
2386
|
sig {
|
2853
2387
|
params(set: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::SetPauseCollection::Set, type: String).void
|
2854
2388
|
}
|
@@ -2859,7 +2393,6 @@ module Stripe
|
|
2859
2393
|
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
2860
2394
|
sig { returns(String) }
|
2861
2395
|
attr_accessor :prorate_up_front
|
2862
|
-
|
2863
2396
|
sig { params(prorate_up_front: String).void }
|
2864
2397
|
def initialize(prorate_up_front: nil); end
|
2865
2398
|
end
|
@@ -2868,7 +2401,6 @@ module Stripe
|
|
2868
2401
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::TrialSettings::EndBehavior)
|
2869
2402
|
}
|
2870
2403
|
attr_accessor :end_behavior
|
2871
|
-
|
2872
2404
|
sig {
|
2873
2405
|
params(end_behavior: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::TrialSettings::EndBehavior).void
|
2874
2406
|
}
|
@@ -2877,49 +2409,39 @@ module Stripe
|
|
2877
2409
|
# 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.
|
2878
2410
|
sig { returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd) }
|
2879
2411
|
attr_accessor :amendment_end
|
2880
|
-
|
2881
2412
|
# Details to identify the earliest timestamp where the proposed change should take effect.
|
2882
2413
|
sig { returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart) }
|
2883
2414
|
attr_accessor :amendment_start
|
2884
|
-
|
2885
2415
|
# 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.
|
2886
2416
|
sig { returns(String) }
|
2887
2417
|
attr_accessor :billing_cycle_anchor
|
2888
|
-
|
2889
2418
|
# Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
2890
2419
|
sig {
|
2891
2420
|
returns(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction])
|
2892
2421
|
}
|
2893
2422
|
attr_accessor :discount_actions
|
2894
|
-
|
2895
2423
|
# Changes to the subscription items during the amendment time span.
|
2896
2424
|
sig {
|
2897
2425
|
returns(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction])
|
2898
2426
|
}
|
2899
2427
|
attr_accessor :item_actions
|
2900
|
-
|
2901
2428
|
# Instructions for how to modify phase metadata
|
2902
2429
|
sig {
|
2903
2430
|
returns(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::MetadataAction])
|
2904
2431
|
}
|
2905
2432
|
attr_accessor :metadata_actions
|
2906
|
-
|
2907
2433
|
# 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`.
|
2908
2434
|
sig { returns(String) }
|
2909
2435
|
attr_accessor :proration_behavior
|
2910
|
-
|
2911
2436
|
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
2912
2437
|
sig { returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::SetPauseCollection) }
|
2913
2438
|
attr_accessor :set_pause_collection
|
2914
|
-
|
2915
2439
|
# Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
2916
2440
|
sig { returns(String) }
|
2917
2441
|
attr_accessor :set_schedule_end
|
2918
|
-
|
2919
2442
|
# Settings related to subscription trials.
|
2920
2443
|
sig { returns(::Stripe::SubscriptionSchedule::AmendParams::Amendment::TrialSettings) }
|
2921
2444
|
attr_accessor :trial_settings
|
2922
|
-
|
2923
2445
|
sig {
|
2924
2446
|
params(amendment_end: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentEnd, amendment_start: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::AmendmentStart, billing_cycle_anchor: String, discount_actions: T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::DiscountAction], item_actions: T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::ItemAction], metadata_actions: T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment::MetadataAction], proration_behavior: String, set_pause_collection: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::SetPauseCollection, set_schedule_end: String, trial_settings: ::Stripe::SubscriptionSchedule::AmendParams::Amendment::TrialSettings).void
|
2925
2447
|
}
|
@@ -2942,7 +2464,6 @@ module Stripe
|
|
2942
2464
|
# The position of the amendment in the `amendments` array with which prebilling should begin. Indexes start from 0 and must be less than the total number of supplied amendments.
|
2943
2465
|
sig { returns(Integer) }
|
2944
2466
|
attr_accessor :index
|
2945
|
-
|
2946
2467
|
sig { params(index: Integer).void }
|
2947
2468
|
def initialize(index: nil); end
|
2948
2469
|
end
|
@@ -2951,15 +2472,12 @@ module Stripe
|
|
2951
2472
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillFrom::AmendmentStart)
|
2952
2473
|
}
|
2953
2474
|
attr_accessor :amendment_start
|
2954
|
-
|
2955
2475
|
# Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
2956
2476
|
sig { returns(Integer) }
|
2957
2477
|
attr_accessor :timestamp
|
2958
|
-
|
2959
2478
|
# Select one of several ways to pass the `bill_from` value.
|
2960
2479
|
sig { returns(String) }
|
2961
2480
|
attr_accessor :type
|
2962
|
-
|
2963
2481
|
sig {
|
2964
2482
|
params(amendment_start: ::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillFrom::AmendmentStart, timestamp: Integer, type: String).void
|
2965
2483
|
}
|
@@ -2970,7 +2488,6 @@ module Stripe
|
|
2970
2488
|
# 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.
|
2971
2489
|
sig { returns(Integer) }
|
2972
2490
|
attr_accessor :index
|
2973
|
-
|
2974
2491
|
sig { params(index: Integer).void }
|
2975
2492
|
def initialize(index: nil); end
|
2976
2493
|
end
|
@@ -2978,11 +2495,9 @@ module Stripe
|
|
2978
2495
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2979
2496
|
sig { returns(String) }
|
2980
2497
|
attr_accessor :interval
|
2981
|
-
|
2982
2498
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2983
2499
|
sig { returns(Integer) }
|
2984
2500
|
attr_accessor :interval_count
|
2985
|
-
|
2986
2501
|
sig { params(interval: String, interval_count: Integer).void }
|
2987
2502
|
def initialize(interval: nil, interval_count: nil); end
|
2988
2503
|
end
|
@@ -2991,21 +2506,17 @@ module Stripe
|
|
2991
2506
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil::AmendmentEnd)
|
2992
2507
|
}
|
2993
2508
|
attr_accessor :amendment_end
|
2994
|
-
|
2995
2509
|
# Time span for prebilling, starting from `bill_from`.
|
2996
2510
|
sig {
|
2997
2511
|
returns(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil::Duration)
|
2998
2512
|
}
|
2999
2513
|
attr_accessor :duration
|
3000
|
-
|
3001
2514
|
# End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
3002
2515
|
sig { returns(Integer) }
|
3003
2516
|
attr_accessor :timestamp
|
3004
|
-
|
3005
2517
|
# Select one of several ways to pass the `bill_until` value.
|
3006
2518
|
sig { returns(String) }
|
3007
2519
|
attr_accessor :type
|
3008
|
-
|
3009
2520
|
sig {
|
3010
2521
|
params(amendment_end: ::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil::AmendmentEnd, duration: ::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil::Duration, timestamp: Integer, type: String).void
|
3011
2522
|
}
|
@@ -3014,19 +2525,15 @@ module Stripe
|
|
3014
2525
|
# The beginning of the prebilled time period. The default value is `now`.
|
3015
2526
|
sig { returns(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillFrom) }
|
3016
2527
|
attr_accessor :bill_from
|
3017
|
-
|
3018
2528
|
# The end of the prebilled time period.
|
3019
2529
|
sig { returns(::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil) }
|
3020
2530
|
attr_accessor :bill_until
|
3021
|
-
|
3022
2531
|
# When the prebilling invoice should be created. The default value is `now`.
|
3023
2532
|
sig { returns(String) }
|
3024
2533
|
attr_accessor :invoice_at
|
3025
|
-
|
3026
2534
|
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
3027
2535
|
sig { returns(String) }
|
3028
2536
|
attr_accessor :update_behavior
|
3029
|
-
|
3030
2537
|
sig {
|
3031
2538
|
params(bill_from: ::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillFrom, bill_until: ::Stripe::SubscriptionSchedule::AmendParams::Prebilling::BillUntil, invoice_at: String, update_behavior: String).void
|
3032
2539
|
}
|
@@ -3036,31 +2543,25 @@ module Stripe
|
|
3036
2543
|
# Behavior of the subscription schedule and underlying subscription when it ends.
|
3037
2544
|
sig { returns(String) }
|
3038
2545
|
attr_accessor :end_behavior
|
3039
|
-
|
3040
2546
|
sig { params(end_behavior: String).void }
|
3041
2547
|
def initialize(end_behavior: nil); end
|
3042
2548
|
end
|
3043
2549
|
# Changes to apply to the phases of the subscription schedule, in the order provided.
|
3044
2550
|
sig { returns(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment]) }
|
3045
2551
|
attr_accessor :amendments
|
3046
|
-
|
3047
2552
|
# Specifies which fields in the response should be expanded.
|
3048
2553
|
sig { returns(T::Array[String]) }
|
3049
2554
|
attr_accessor :expand
|
3050
|
-
|
3051
2555
|
# Provide any time periods to bill in advance.
|
3052
2556
|
sig { returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Prebilling])) }
|
3053
2557
|
attr_accessor :prebilling
|
3054
|
-
|
3055
2558
|
# In cases where the amendment changes the currently active phase,
|
3056
2559
|
# specifies if and how to prorate at the time of the request.
|
3057
2560
|
sig { returns(String) }
|
3058
2561
|
attr_accessor :proration_behavior
|
3059
|
-
|
3060
2562
|
# Changes to apply to the subscription schedule.
|
3061
2563
|
sig { returns(::Stripe::SubscriptionSchedule::AmendParams::ScheduleSettings) }
|
3062
2564
|
attr_accessor :schedule_settings
|
3063
|
-
|
3064
2565
|
sig {
|
3065
2566
|
params(amendments: T::Array[::Stripe::SubscriptionSchedule::AmendParams::Amendment], expand: T::Array[String], prebilling: T.nilable(T::Array[::Stripe::SubscriptionSchedule::AmendParams::Prebilling]), proration_behavior: String, schedule_settings: ::Stripe::SubscriptionSchedule::AmendParams::ScheduleSettings).void
|
3066
2567
|
}
|
@@ -3076,15 +2577,12 @@ module Stripe
|
|
3076
2577
|
# Specifies which fields in the response should be expanded.
|
3077
2578
|
sig { returns(T::Array[String]) }
|
3078
2579
|
attr_accessor :expand
|
3079
|
-
|
3080
2580
|
# If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.
|
3081
2581
|
sig { returns(T::Boolean) }
|
3082
2582
|
attr_accessor :invoice_now
|
3083
|
-
|
3084
2583
|
# If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.
|
3085
2584
|
sig { returns(T::Boolean) }
|
3086
2585
|
attr_accessor :prorate
|
3087
|
-
|
3088
2586
|
sig { params(expand: T::Array[String], invoice_now: T::Boolean, prorate: T::Boolean).void }
|
3089
2587
|
def initialize(expand: nil, invoice_now: nil, prorate: nil); end
|
3090
2588
|
end
|
@@ -3092,11 +2590,9 @@ module Stripe
|
|
3092
2590
|
# Specifies which fields in the response should be expanded.
|
3093
2591
|
sig { returns(T::Array[String]) }
|
3094
2592
|
attr_accessor :expand
|
3095
|
-
|
3096
2593
|
# Keep any cancellation on the subscription that the schedule has set
|
3097
2594
|
sig { returns(T::Boolean) }
|
3098
2595
|
attr_accessor :preserve_cancel_date
|
3099
|
-
|
3100
2596
|
sig { params(expand: T::Array[String], preserve_cancel_date: T::Boolean).void }
|
3101
2597
|
def initialize(expand: nil, preserve_cancel_date: nil); end
|
3102
2598
|
end
|