Class: Stripe::SubscriptionItem::UpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/subscription_item.rb

Defined Under Namespace

Classes: BillingThresholds, Discount, PriceData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(billing_thresholds: nil, discounts: nil, expand: nil, metadata: nil, off_session: nil, payment_behavior: nil, plan: nil, price: nil, price_data: nil, proration_behavior: nil, proration_date: nil, quantity: nil, tax_rates: nil) ⇒ UpdateParams

Returns a new instance of UpdateParams.



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/stripe/resources/subscription_item.rb', line 214

def initialize(
  billing_thresholds: nil,
  discounts: nil,
  expand: nil,
  metadata: nil,
  off_session: nil,
  payment_behavior: nil,
  plan: nil,
  price: nil,
  price_data: nil,
  proration_behavior: nil,
  proration_date: nil,
  quantity: nil,
  tax_rates: nil
)
  @billing_thresholds = billing_thresholds
  @discounts = discounts
  @expand = expand
  @metadata = metadata
  @off_session = off_session
  @payment_behavior = payment_behavior
  @plan = plan
  @price = price
  @price_data = price_data
  @proration_behavior = proration_behavior
  @proration_date = proration_date
  @quantity = quantity
  @tax_rates = tax_rates
end

Instance Attribute Details

#billing_thresholds ⇒ Object

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.



170
171
172
 
# File 'lib/stripe/resources/subscription_item.rb', line 170

def billing_thresholds
  @billing_thresholds
end

#discounts ⇒ Object

The coupons to redeem into discounts for the subscription item.



173
174
175
 
# File 'lib/stripe/resources/subscription_item.rb', line 173

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



176
177
178
 
# File 'lib/stripe/resources/subscription_item.rb', line 176

def expand
  @expand
end

#metadata ⇒ Object

Set of [key-value pairs](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`.



179
180
181
 
# File 'lib/stripe/resources/subscription_item.rb', line 179

def metadata
  @metadata
end

#off_session ⇒ Object

Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to ‘false` (on-session).



182
183
184
 
# File 'lib/stripe/resources/subscription_item.rb', line 182

def off_session
  @off_session
end

#payment_behavior ⇒ Object

Use ‘allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription’s invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.

Use ‘default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice’s payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.

Use ‘pending_if_incomplete` to update the subscription using [pending updates](stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](stripe.com/docs/billing/pending-updates-reference#supported-attributes).

Use ‘error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription’s invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](stripe.com/docs/upgrades#2019-03-14) to learn more.



191
192
193
 
# File 'lib/stripe/resources/subscription_item.rb', line 191

def payment_behavior
  @payment_behavior
end

#plan ⇒ Object

The identifier of the new plan for this subscription item.



194
195
196
 
# File 'lib/stripe/resources/subscription_item.rb', line 194

def plan
  @plan
end

#price ⇒ Object

The ID of the price object. One of ‘price` or `price_data` is required. When changing a subscription item’s price, ‘quantity` is set to 1 unless a `quantity` parameter is provided.



197
198
199
 
# File 'lib/stripe/resources/subscription_item.rb', line 197

def price
  @price
end

#price_data ⇒ Object

Data used to generate a new [Price](stripe.com/docs/api/prices) object inline. One of ‘price` or `price_data` is required.



200
201
202
 
# File 'lib/stripe/resources/subscription_item.rb', line 200

def price_data
  @price_data
end

#proration_behavior ⇒ Object

Determines how to handle [prorations](stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting ‘billing_cycle_anchor=now`, or starting a trial), or if an item’s ‘quantity` changes. The default value is `create_prorations`.



203
204
205
 
# File 'lib/stripe/resources/subscription_item.rb', line 203

def proration_behavior
  @proration_behavior
end

#proration_date ⇒ Object

If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](stripe.com/docs/api#retrieve_customer_invoice) endpoint.



206
207
208
 
# File 'lib/stripe/resources/subscription_item.rb', line 206

def proration_date
  @proration_date
end

#quantity ⇒ Object

The quantity you’d like to apply to the subscription item you’re creating.



209
210
211
 
# File 'lib/stripe/resources/subscription_item.rb', line 209

def quantity
  @quantity
end

#tax_rates ⇒ Object

A list of [Tax Rate](stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [‘default_tax_rates`](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.



212
213
214
 
# File 'lib/stripe/resources/subscription_item.rb', line 212

def tax_rates
  @tax_rates
end