Class: Stripe::Product

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

Overview

Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. They can be used in conjunction with [Prices](api.stripe.com#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.

Related guides: [Set up a subscription](docs.stripe.com/billing/subscriptions/set-up-subscription), [share a Payment Link](docs.stripe.com/payment-links), [accept payments with Checkout](docs.stripe.com/payments/accept-a-payment#create-product-prices-upfront), and more about [Products and Prices](docs.stripe.com/products-prices/overview)

Defined Under Namespace

Classes: MarketingFeature, PackageDimensions, TaxDetails

Constant Summary collapse

OBJECT_NAME = 
"product"

Constants inherited from StripeObject

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

_search

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

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #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

#active ⇒ Object (readonly)

Whether the product is currently available for purchase.



75
76
77
 
# File 'lib/stripe/resources/product.rb', line 75

def active
  @active
end

#created ⇒ Object (readonly)

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



77
78
79
 
# File 'lib/stripe/resources/product.rb', line 77

def created
  @created
end

#default_price ⇒ Object (readonly)

The ID of the [Price](docs.stripe.com/api/prices) object that is the default price for this product.



79
80
81
 
# File 'lib/stripe/resources/product.rb', line 79

def default_price
  @default_price
end

#deleted ⇒ Object (readonly)

Always true for a deleted object



81
82
83
 
# File 'lib/stripe/resources/product.rb', line 81

def deleted
  @deleted
end

#description ⇒ Object (readonly)

The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.



83
84
85
 
# File 'lib/stripe/resources/product.rb', line 83

def description
  @description
end

#id ⇒ Object (readonly)

Unique identifier for the object.



85
86
87
 
# File 'lib/stripe/resources/product.rb', line 85

def id
  @id
end

#images ⇒ Object (readonly)

A list of up to 8 URLs of images for this product, meant to be displayable to the customer.



87
88
89
 
# File 'lib/stripe/resources/product.rb', line 87

def images
  @images
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is ‘true`. If the object exists in test mode, the value is `false`.



89
90
91
 
# File 'lib/stripe/resources/product.rb', line 89

def livemode
  @livemode
end

#marketing_features ⇒ Object (readonly)

A list of up to 15 marketing features for this product. These are displayed in [pricing tables](docs.stripe.com/payments/checkout/pricing-table).



91
92
93
 
# File 'lib/stripe/resources/product.rb', line 91

def marketing_features
  @marketing_features
end

#metadata ⇒ Object (readonly)

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.



93
94
95
 
# File 'lib/stripe/resources/product.rb', line 93

def metadata
  @metadata
end

#name ⇒ Object (readonly)

The product’s name, meant to be displayable to the customer.



95
96
97
 
# File 'lib/stripe/resources/product.rb', line 95

def name
  @name
end

#object ⇒ Object (readonly)

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



97
98
99
 
# File 'lib/stripe/resources/product.rb', line 97

def object
  @object
end

#package_dimensions ⇒ Object (readonly)

The dimensions of this product for shipping purposes.



99
100
101
 
# File 'lib/stripe/resources/product.rb', line 99

def package_dimensions
  @package_dimensions
end

#shippable ⇒ Object (readonly)

Whether this product is shipped (i.e., physical goods).



101
102
103
 
# File 'lib/stripe/resources/product.rb', line 101

def shippable
  @shippable
end

#statement_descriptor ⇒ Object (readonly)

Extra information about a product which will appear on your customer’s credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.



103
104
105
 
# File 'lib/stripe/resources/product.rb', line 103

def statement_descriptor
  @statement_descriptor
end

#tax_code ⇒ Object (readonly)

A [tax code](docs.stripe.com/tax/tax-categories) ID.



105
106
107
 
# File 'lib/stripe/resources/product.rb', line 105

def tax_code
  @tax_code
end

#tax_details ⇒ Object (readonly)

Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.



107
108
109
 
# File 'lib/stripe/resources/product.rb', line 107

def tax_details
  @tax_details
end

#type ⇒ Object (readonly)

The type of the product. The product is either of type ‘good`, which is eligible for use with Orders and SKUs, or `service`, which is eligible for use with Subscriptions and Plans.



109
110
111
 
# File 'lib/stripe/resources/product.rb', line 109

def type
  @type
end

#unit_label ⇒ Object (readonly)

A label that represents units of this product. When set, this will be included in customers’ receipts, invoices, Checkout, and the customer portal.



111
112
113
 
# File 'lib/stripe/resources/product.rb', line 111

def unit_label
  @unit_label
end

#updated ⇒ Object (readonly)

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



113
114
115
 
# File 'lib/stripe/resources/product.rb', line 113

def updated
  @updated
end

#url ⇒ Object (readonly)

A URL of a publicly-accessible webpage for this product.



115
116
117
 
# File 'lib/stripe/resources/product.rb', line 115

def url
  @url
end

Class Method Details

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

Creates a new product object.



118
119
120
 
# File 'lib/stripe/resources/product.rb', line 118

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

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

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.



123
124
125
126
127
128
129
130
 
# File 'lib/stripe/resources/product.rb', line 123

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

.field_remappings ⇒ Object 



173
174
175
 
# File 'lib/stripe/resources/product.rb', line 173

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



165
166
167
168
169
170
171
 
# File 'lib/stripe/resources/product.rb', line 165

def self.inner_class_types
  @inner_class_types = {
    marketing_features: MarketingFeature,
    package_dimensions: PackageDimensions,
    tax_details: TaxDetails,
  }
end

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

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.



143
144
145
 
# File 'lib/stripe/resources/product.rb', line 143

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

.object_name ⇒ Object 



22
23
24
 
# File 'lib/stripe/resources/product.rb', line 22

def self.object_name
  "product"
end

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



147
148
149
 
# File 'lib/stripe/resources/product.rb', line 147

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

.search_auto_paging_each(params = {}, opts = {}, &blk) ⇒ Object 



151
152
153
 
# File 'lib/stripe/resources/product.rb', line 151

def self.search_auto_paging_each(params = {}, opts = {}, &blk)
  search(params, opts).auto_paging_each(&blk)
end

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

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.



156
157
158
159
160
161
162
163
 
# File 'lib/stripe/resources/product.rb', line 156

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

Instance Method Details

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

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.



133
134
135
136
137
138
139
140
 
# File 'lib/stripe/resources/product.rb', line 133

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