Class: Stripe::SubscriptionItem

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List, APIOperations::NestedResource
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: BillingThresholds, Trial

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::NestedResource

nested_resource_class_methods

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

#billing_thresholds ⇒ Object (readonly)

Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period



32
33
34
 
# File 'lib/stripe/resources/subscription_item.rb', line 32

def billing_thresholds
  @billing_thresholds
end

#created ⇒ Object (readonly)

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



34
35
36
 
# File 'lib/stripe/resources/subscription_item.rb', line 34

def created
  @created
end

#deleted ⇒ Object (readonly)

Always true for a deleted object



68
69
70
 
# File 'lib/stripe/resources/subscription_item.rb', line 68

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.



36
37
38
 
# File 'lib/stripe/resources/subscription_item.rb', line 36

def discounts
  @discounts
end

#id ⇒ Object (readonly)

Unique identifier for the object.



38
39
40
 
# File 'lib/stripe/resources/subscription_item.rb', line 38

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.



40
41
42
 
# File 'lib/stripe/resources/subscription_item.rb', line 40

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



42
43
44
 
# File 'lib/stripe/resources/subscription_item.rb', line 42

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



51
52
53
 
# File 'lib/stripe/resources/subscription_item.rb', line 51

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



58
59
60
 
# File 'lib/stripe/resources/subscription_item.rb', line 58

def price
  @price
end

#quantity ⇒ Object (readonly)

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



60
61
62
 
# File 'lib/stripe/resources/subscription_item.rb', line 60

def quantity
  @quantity
end

#subscription ⇒ Object (readonly)

The ‘subscription` this `subscription_item` belongs to.



62
63
64
 
# File 'lib/stripe/resources/subscription_item.rb', line 62

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



64
65
66
 
# File 'lib/stripe/resources/subscription_item.rb', line 64

def tax_rates
  @tax_rates
end

#trial ⇒ Object (readonly)

Options that configure the trial on the subscription item.



66
67
68
 
# File 'lib/stripe/resources/subscription_item.rb', line 66

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.



71
72
73
74
75
76
77
78
 
# File 'lib/stripe/resources/subscription_item.rb', line 71

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

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

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



81
82
83
84
85
86
87
88
 
# File 'lib/stripe/resources/subscription_item.rb', line 81

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

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

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



101
102
103
104
105
106
107
108
 
# File 'lib/stripe/resources/subscription_item.rb', line 101

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

.object_name ⇒ Object 



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

def self.object_name
  "subscription_item"
end

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

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



111
112
113
114
115
116
117
118
 
# File 'lib/stripe/resources/subscription_item.rb', line 111

def self.update(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/subscription_items/%<id>s", { id: CGI.escape(id) }),
    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.



91
92
93
94
95
96
97
98
 
# File 'lib/stripe/resources/subscription_item.rb', line 91

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