From a0ffd3098d9e3d2476c4808ca65fc5aabbc8650d Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Tue, 13 May 2025 20:28:36 +0000 Subject: [PATCH] Update generated code for v1751 --- OPENAPI_VERSION | 2 +- lib/stripe/resources/invoice.rb | 2 +- lib/stripe/resources/subscription.rb | 6 ++--- lib/stripe/services/invoice_service.rb | 2 +- lib/stripe/services/subscription_service.rb | 4 ++-- rbi/stripe.rbi | 22 +++++++++---------- rbi/stripe/resources/checkout/session.rbi | 4 ++-- rbi/stripe/resources/invoice.rbi | 2 +- rbi/stripe/resources/subscription.rbi | 6 ++--- .../services/checkout/session_service.rbi | 4 ++-- rbi/stripe/services/invoice_service.rbi | 2 +- rbi/stripe/services/subscription_service.rbi | 4 ++-- 12 files changed, 30 insertions(+), 30 deletions(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 3256485d..be22ae34 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v1748 \ No newline at end of file +v1751 \ No newline at end of file diff --git a/lib/stripe/resources/invoice.rb b/lib/stripe/resources/invoice.rb index a28dbbbd..5c7349cb 100644 --- a/lib/stripe/resources/invoice.rb +++ b/lib/stripe/resources/invoice.rb @@ -4038,7 +4038,7 @@ module Stripe attr_accessor :billing_mode # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. attr_accessor :cancel_at_period_end # This simulates the subscription being canceled or expired immediately. attr_accessor :cancel_now diff --git a/lib/stripe/resources/subscription.rb b/lib/stripe/resources/subscription.rb index 6ad8a8a8..38626454 100644 --- a/lib/stripe/resources/subscription.rb +++ b/lib/stripe/resources/subscription.rb @@ -855,7 +855,7 @@ module Stripe attr_accessor :billing_cycle_anchor # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. attr_accessor :cancel_at_period_end # Details about why this subscription was cancelled attr_accessor :cancellation_details @@ -1708,7 +1708,7 @@ module Stripe attr_accessor :billing_mode # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. attr_accessor :cancel_at_period_end # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`. attr_accessor :collection_method @@ -1902,7 +1902,7 @@ module Stripe attr_reader :billing_mode # A date in the future at which the subscription will automatically get canceled attr_reader :cancel_at - # Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. + # Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. This field will be removed in a future API version. Please use `cancel_at` instead. attr_reader :cancel_at_period_end # If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. attr_reader :canceled_at diff --git a/lib/stripe/services/invoice_service.rb b/lib/stripe/services/invoice_service.rb index 731e98d6..1afcdfa7 100644 --- a/lib/stripe/services/invoice_service.rb +++ b/lib/stripe/services/invoice_service.rb @@ -3561,7 +3561,7 @@ module Stripe attr_accessor :billing_mode # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. attr_accessor :cancel_at_period_end # This simulates the subscription being canceled or expired immediately. attr_accessor :cancel_now diff --git a/lib/stripe/services/subscription_service.rb b/lib/stripe/services/subscription_service.rb index 405fc584..c2b3c1dd 100644 --- a/lib/stripe/services/subscription_service.rb +++ b/lib/stripe/services/subscription_service.rb @@ -629,7 +629,7 @@ module Stripe attr_accessor :billing_cycle_anchor # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. attr_accessor :cancel_at_period_end # Details about why this subscription was cancelled attr_accessor :cancellation_details @@ -1482,7 +1482,7 @@ module Stripe attr_accessor :billing_mode # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. attr_accessor :cancel_at_period_end # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`. attr_accessor :collection_method diff --git a/rbi/stripe.rbi b/rbi/stripe.rbi index e261c8d2..829f12c5 100644 --- a/rbi/stripe.rbi +++ b/rbi/stripe.rbi @@ -22947,13 +22947,13 @@ module Stripe sig { returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData)) } attr_accessor :price_data # The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`. - sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) } + sig { returns(T.nilable(Integer)) } attr_accessor :quantity # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(adjustable_quantity: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), price: T.nilable(String), price_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData), quantity: T.nilable(T.nilable(T.any(String, Integer))), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(adjustable_quantity: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), price: T.nilable(String), price_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( adjustable_quantity: nil, @@ -37135,7 +37135,7 @@ module Stripe # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.nilable(T.any(String, T.any(Integer, String))))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # This simulates the subscription being canceled or expired immediately. @@ -91276,7 +91276,7 @@ module Stripe # A date in the future at which the subscription will automatically get canceled sig { returns(T.nilable(Integer)) } attr_reader :cancel_at - # Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. + # Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. This field will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T::Boolean) } attr_reader :cancel_at_period_end # If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. @@ -92071,7 +92071,7 @@ module Stripe # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.nilable(T.any(String, T.any(Integer, String))))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # Details about why this subscription was cancelled @@ -92981,7 +92981,7 @@ module Stripe # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.any(Integer, String))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`. @@ -123460,13 +123460,13 @@ module Stripe } attr_accessor :price_data # The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`. - sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) } + sig { returns(T.nilable(Integer)) } attr_accessor :quantity # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(adjustable_quantity: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::AdjustableQuantity), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), price: T.nilable(String), price_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData), quantity: T.nilable(T.nilable(T.any(String, Integer))), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(adjustable_quantity: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::AdjustableQuantity), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), price: T.nilable(String), price_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( adjustable_quantity: nil, @@ -135526,7 +135526,7 @@ module Stripe # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.nilable(T.any(String, T.any(Integer, String))))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # This simulates the subscription being canceled or expired immediately. @@ -171834,7 +171834,7 @@ module Stripe # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.nilable(T.any(String, T.any(Integer, String))))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # Details about why this subscription was cancelled @@ -172756,7 +172756,7 @@ module Stripe # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.any(Integer, String))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`. diff --git a/rbi/stripe/resources/checkout/session.rbi b/rbi/stripe/resources/checkout/session.rbi index 4506c801..c1d3bf24 100644 --- a/rbi/stripe/resources/checkout/session.rbi +++ b/rbi/stripe/resources/checkout/session.rbi @@ -4124,13 +4124,13 @@ module Stripe sig { returns(T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData)) } attr_accessor :price_data # The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`. - sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) } + sig { returns(T.nilable(Integer)) } attr_accessor :quantity # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(adjustable_quantity: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), price: T.nilable(String), price_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData), quantity: T.nilable(T.nilable(T.any(String, Integer))), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(adjustable_quantity: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::AdjustableQuantity), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), price: T.nilable(String), price_data: T.nilable(::Stripe::Checkout::Session::UpdateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( adjustable_quantity: nil, diff --git a/rbi/stripe/resources/invoice.rbi b/rbi/stripe/resources/invoice.rbi index b1846d97..5ba21f2d 100644 --- a/rbi/stripe/resources/invoice.rbi +++ b/rbi/stripe/resources/invoice.rbi @@ -4661,7 +4661,7 @@ module Stripe # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.nilable(T.any(String, T.any(Integer, String))))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # This simulates the subscription being canceled or expired immediately. diff --git a/rbi/stripe/resources/subscription.rbi b/rbi/stripe/resources/subscription.rbi index bedb773b..5b982e99 100644 --- a/rbi/stripe/resources/subscription.rbi +++ b/rbi/stripe/resources/subscription.rbi @@ -306,7 +306,7 @@ module Stripe # A date in the future at which the subscription will automatically get canceled sig { returns(T.nilable(Integer)) } attr_reader :cancel_at - # Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. + # Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. This field will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T::Boolean) } attr_reader :cancel_at_period_end # If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. @@ -1101,7 +1101,7 @@ module Stripe # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.nilable(T.any(String, T.any(Integer, String))))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # Details about why this subscription was cancelled @@ -2011,7 +2011,7 @@ module Stripe # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.any(Integer, String))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`. diff --git a/rbi/stripe/services/checkout/session_service.rbi b/rbi/stripe/services/checkout/session_service.rbi index 1a0b354b..ade11748 100644 --- a/rbi/stripe/services/checkout/session_service.rbi +++ b/rbi/stripe/services/checkout/session_service.rbi @@ -2662,13 +2662,13 @@ module Stripe } attr_accessor :price_data # The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`. - sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) } + sig { returns(T.nilable(Integer)) } attr_accessor :quantity # The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(adjustable_quantity: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::AdjustableQuantity), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), price: T.nilable(String), price_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData), quantity: T.nilable(T.nilable(T.any(String, Integer))), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(adjustable_quantity: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::AdjustableQuantity), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), price: T.nilable(String), price_data: T.nilable(::Stripe::Checkout::SessionService::UpdateParams::LineItem::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( adjustable_quantity: nil, diff --git a/rbi/stripe/services/invoice_service.rbi b/rbi/stripe/services/invoice_service.rbi index 13b298d4..c6869daa 100644 --- a/rbi/stripe/services/invoice_service.rbi +++ b/rbi/stripe/services/invoice_service.rbi @@ -3833,7 +3833,7 @@ module Stripe # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.nilable(T.any(String, T.any(Integer, String))))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # This simulates the subscription being canceled or expired immediately. diff --git a/rbi/stripe/services/subscription_service.rbi b/rbi/stripe/services/subscription_service.rbi index c533586e..fea7b973 100644 --- a/rbi/stripe/services/subscription_service.rbi +++ b/rbi/stripe/services/subscription_service.rbi @@ -687,7 +687,7 @@ module Stripe # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.nilable(T.any(String, T.any(Integer, String))))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # Details about why this subscription was cancelled @@ -1609,7 +1609,7 @@ module Stripe # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.any(Integer, String))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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`.