Class: Stripe::Subscription::CreateParams::Item

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

Defined Under Namespace

Classes: BillingThresholds, Discount, PriceData, Trial

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(billing_thresholds: 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.



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
 
# File 'lib/stripe/resources/subscription.rb', line 1500

def initialize(
  billing_thresholds: nil,
  discounts: nil,
  metadata: nil,
  plan: nil,
  price: nil,
  price_data: nil,
  quantity: nil,
  tax_rates: nil,
  trial: nil
)
  @billing_thresholds = billing_thresholds
  @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.



1482
1483
1484
 
# File 'lib/stripe/resources/subscription.rb', line 1482

def billing_thresholds
  @billing_thresholds
end

#discounts ⇒ Object

The coupons to redeem into discounts for the subscription item.



1484
1485
1486
 
# File 'lib/stripe/resources/subscription.rb', line 1484

def discounts
  @discounts
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`.



1486
1487
1488
 
# File 'lib/stripe/resources/subscription.rb', line 1486

def metadata
  @metadata
end

#plan ⇒ Object

Plan ID for this item, as a string.



1488
1489
1490
 
# File 'lib/stripe/resources/subscription.rb', line 1488

def plan
  @plan
end

#price ⇒ Object

The ID of the price object.



1490
1491
1492
 
# File 'lib/stripe/resources/subscription.rb', line 1490

def price
  @price
end

#price_data ⇒ Object

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



1492
1493
1494
 
# File 'lib/stripe/resources/subscription.rb', line 1492

def price_data
  @price_data
end

#quantity ⇒ Object

Quantity for this item.



1494
1495
1496
 
# File 'lib/stripe/resources/subscription.rb', line 1494

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.



1496
1497
1498
 
# File 'lib/stripe/resources/subscription.rb', line 1496

def tax_rates
  @tax_rates
end

#trial ⇒ Object

Define options to configure the trial on the subscription item.



1498
1499
1500
 
# File 'lib/stripe/resources/subscription.rb', line 1498

def trial
  @trial
end