Class: Stripe::SubscriptionItem::CreateParams

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

Defined Under Namespace

Classes: Discount, PriceData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(discounts: nil, expand: nil, metadata: nil, payment_behavior: nil, plan: nil, price: nil, price_data: nil, proration_behavior: nil, proration_date: nil, quantity: nil, subscription: nil, tax_rates: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/stripe/resources/subscription_item.rb', line 265

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

Instance Attribute Details

#discounts ⇒ Object

The coupons to redeem into discounts for the subscription item.



235
236
237
 
# File 'lib/stripe/resources/subscription_item.rb', line 235

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



237
238
239
 
# File 'lib/stripe/resources/subscription_item.rb', line 237

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`.



239
240
241
 
# File 'lib/stripe/resources/subscription_item.rb', line 239

def metadata
  @metadata
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.



247
248
249
 
# File 'lib/stripe/resources/subscription_item.rb', line 247

def payment_behavior
  @payment_behavior
end

#plan ⇒ Object

The identifier of the plan to add to the subscription.



249
250
251
 
# File 'lib/stripe/resources/subscription_item.rb', line 249

def plan
  @plan
end

#price ⇒ Object

The ID of the price object.



251
252
253
 
# File 'lib/stripe/resources/subscription_item.rb', line 251

def price
  @price
end

#price_data ⇒ Object

Data used to generate a new [Price](stripe.com/docs/api/prices) object inline.



253
254
255
 
# File 'lib/stripe/resources/subscription_item.rb', line 253

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`.



255
256
257
 
# File 'lib/stripe/resources/subscription_item.rb', line 255

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.



257
258
259
 
# File 'lib/stripe/resources/subscription_item.rb', line 257

def proration_date
  @proration_date
end

#quantity ⇒ Object

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



259
260
261
 
# File 'lib/stripe/resources/subscription_item.rb', line 259

def quantity
  @quantity
end

#subscription ⇒ Object

The identifier of the subscription to modify.



261
262
263
 
# File 'lib/stripe/resources/subscription_item.rb', line 261

def subscription
  @subscription
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.



263
264
265
 
# File 'lib/stripe/resources/subscription_item.rb', line 263

def tax_rates
  @tax_rates
end