Class: Stripe::SubscriptionCreateParams::Item

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/subscription_create_params.rb

Defined Under Namespace

Classes: BillingThresholds, CurrentTrial, Discount, PriceData, Trial

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, new, #to_h

Constructor Details

#initialize(billing_thresholds: nil, current_trial: nil, discounts: nil, metadata: nil, plan: nil, price: nil, price_data: nil, quantity: nil, tax_rates: nil, trial: nil) ⇒ Item

Returns a new instance of Item.



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/stripe/params/subscription_create_params.rb', line 523

def initialize(
  billing_thresholds: nil,
  current_trial: nil,
  discounts: nil,
  metadata: nil,
  plan: nil,
  price: nil,
  price_data: nil,
  quantity: nil,
  tax_rates: nil,
  trial: nil
)
  @billing_thresholds = billing_thresholds
  @current_trial = current_trial
  @discounts = discounts
  @metadata = metadata
  @plan = plan
  @price = price
  @price_data = price_data
  @quantity = quantity
  @tax_rates = tax_rates
  @trial = trial
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. Pass an empty string to remove previously-defined thresholds.



503
504
505
 
# File 'lib/stripe/params/subscription_create_params.rb', line 503

def billing_thresholds
  @billing_thresholds
end

#current_trial ⇒ Object

The trial offer to apply to this subscription item.



505
506
507
 
# File 'lib/stripe/params/subscription_create_params.rb', line 505

def current_trial
  @current_trial
end

#discounts ⇒ Object

The coupons to redeem into discounts for the subscription item.



507
508
509
 
# File 'lib/stripe/params/subscription_create_params.rb', line 507

def discounts
  @discounts
end

#metadata ⇒ Object

Set of [key-value pairs](docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



509
510
511
 
# File 'lib/stripe/params/subscription_create_params.rb', line 509

def metadata
  @metadata
end

#plan ⇒ Object

Plan ID for this item, as a string.



511
512
513
 
# File 'lib/stripe/params/subscription_create_params.rb', line 511

def plan
  @plan
end

#price ⇒ Object

The ID of the price object.



513
514
515
 
# File 'lib/stripe/params/subscription_create_params.rb', line 513

def price
  @price
end

#price_data ⇒ Object

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



515
516
517
 
# File 'lib/stripe/params/subscription_create_params.rb', line 515

def price_data
  @price_data
end

#quantity ⇒ Object

Quantity for this item.



517
518
519
 
# File 'lib/stripe/params/subscription_create_params.rb', line 517

def quantity
  @quantity
end

#tax_rates ⇒ Object

A list of [Tax Rate](docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [‘default_tax_rates`](docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.



519
520
521
 
# File 'lib/stripe/params/subscription_create_params.rb', line 519

def tax_rates
  @tax_rates
end

#trial ⇒ Object

Define options to configure the trial on the subscription item.



521
522
523
 
# File 'lib/stripe/params/subscription_create_params.rb', line 521

def trial
  @trial
end

Class Method Details

.field_encodings ⇒ Object 



547
548
549
550
551
 
# File 'lib/stripe/params/subscription_create_params.rb', line 547

def self.field_encodings
  @field_encodings = {
    price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
  }
end