Class: Stripe::SubscriptionItem

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Delete, APIOperations::Save
Defined in:
lib/stripe/resources/subscription_item.rb

Overview

Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.

Defined Under Namespace

Classes: CreateParams, DeleteParams, ListParams, Trial, UpdateParams

Constant Summary collapse

OBJECT_NAME = 
"subscription_item"

Constants inherited from StripeObject

Stripe::StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods included from APIOperations::Delete

included

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



373
374
375
 
# File 'lib/stripe/resources/subscription_item.rb', line 373

def created
  @created
end

#current_period_end ⇒ Object (readonly)

The end time of this subscription item’s current billing period.



375
376
377
 
# File 'lib/stripe/resources/subscription_item.rb', line 375

def current_period_end
  @current_period_end
end

#current_period_start ⇒ Object (readonly)

The start time of this subscription item’s current billing period.



377
378
379
 
# File 'lib/stripe/resources/subscription_item.rb', line 377

def current_period_start
  @current_period_start
end

#deleted ⇒ Object (readonly)

Always true for a deleted object



411
412
413
 
# File 'lib/stripe/resources/subscription_item.rb', line 411

def deleted
  @deleted
end

#discounts ⇒ Object (readonly)

The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use ‘expand[]=discounts` to expand each discount.



379
380
381
 
# File 'lib/stripe/resources/subscription_item.rb', line 379

def discounts
  @discounts
end

#id ⇒ Object (readonly)

Unique identifier for the object.



381
382
383
 
# File 'lib/stripe/resources/subscription_item.rb', line 381

def id
  @id
end

#metadata ⇒ Object (readonly)

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.



383
384
385
 
# File 'lib/stripe/resources/subscription_item.rb', line 383

def metadata
  @metadata
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



385
386
387
 
# File 'lib/stripe/resources/subscription_item.rb', line 385

def object
  @object
end

#plan ⇒ Object (readonly)

You can now model subscriptions more flexibly using the [Prices API](stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.

Plans define the base price, currency, and billing cycle for recurring purchases of products. [Products](stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.

For example, you might have a single “gold” product that has plans for $10/month, $100/year, €9/month, and €90/year.

Related guides: [Set up a subscription](stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](stripe.com/docs/products-prices/overview).



394
395
396
 
# File 'lib/stripe/resources/subscription_item.rb', line 394

def plan
  @plan
end

#price ⇒ Object (readonly)

Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. [Products](stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.

For example, you might have a single “gold” product that has prices for $10/month, $100/year, and €9 once.

Related guides: [Set up a subscription](stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](stripe.com/docs/billing/invoices/create), and more about [products and prices](stripe.com/docs/products-prices/overview).



401
402
403
 
# File 'lib/stripe/resources/subscription_item.rb', line 401

def price
  @price
end

#quantity ⇒ Object (readonly)

The [quantity](stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed.



403
404
405
 
# File 'lib/stripe/resources/subscription_item.rb', line 403

def quantity
  @quantity
end

#subscription ⇒ Object (readonly)

The ‘subscription` this `subscription_item` belongs to.



405
406
407
 
# File 'lib/stripe/resources/subscription_item.rb', line 405

def subscription
  @subscription
end

#tax_rates ⇒ Object (readonly)

The tax rates which apply to this ‘subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.



407
408
409
 
# File 'lib/stripe/resources/subscription_item.rb', line 407

def tax_rates
  @tax_rates
end

#trial ⇒ Object (readonly)

Options that configure the trial on the subscription item.



409
410
411
 
# File 'lib/stripe/resources/subscription_item.rb', line 409

def trial
  @trial
end

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

Adds a new item to an existing subscription. No existing items will be changed or replaced.



414
415
416
417
418
419
420
421
 
# File 'lib/stripe/resources/subscription_item.rb', line 414

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/subscription_items",
    params: params,
    opts: opts
  )
end

.delete(item, params = {}, opts = {}) ⇒ Object

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.



424
425
426
427
428
429
430
431
 
# File 'lib/stripe/resources/subscription_item.rb', line 424

def self.delete(item, params = {}, opts = {})
  request_stripe_object(
    method: :delete,
    path: format("/v1/subscription_items/%<item>s", { item: CGI.escape(item) }),
    params: params,
    opts: opts
  )
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of your subscription items for a given subscription.



444
445
446
447
448
449
450
451
 
# File 'lib/stripe/resources/subscription_item.rb', line 444

def self.list(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/subscription_items",
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



14
15
16
 
# File 'lib/stripe/resources/subscription_item.rb', line 14

def self.object_name
  "subscription_item"
end

.update(item, params = {}, opts = {}) ⇒ Object

Updates the plan or quantity of an item on a current subscription.



454
455
456
457
458
459
460
461
 
# File 'lib/stripe/resources/subscription_item.rb', line 454

def self.update(item, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/subscription_items/%<item>s", { item: CGI.escape(item) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#delete(params = {}, opts = {}) ⇒ Object

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.



434
435
436
437
438
439
440
441
 
# File 'lib/stripe/resources/subscription_item.rb', line 434

def delete(params = {}, opts = {})
  request_stripe_object(
    method: :delete,
    path: format("/v1/subscription_items/%<item>s", { item: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end