Class: Stripe::ProductCreateParams

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

Defined Under Namespace

Classes: DefaultPriceData, MarketingFeature, PackageDimensions

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(active: nil, default_price_data: nil, description: nil, expand: nil, id: nil, images: nil, marketing_features: nil, metadata: nil, name: nil, package_dimensions: nil, shippable: nil, statement_descriptor: nil, tax_code: nil, type: nil, unit_label: nil, url: nil) ⇒ ProductCreateParams 



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/stripe/params/product_create_params.rb', line 207

def initialize(
  active: nil,
  default_price_data: nil,
  description: nil,
  expand: nil,
  id: nil,
  images: nil,
  marketing_features: nil,
  metadata: nil,
  name: nil,
  package_dimensions: nil,
  shippable: nil,
  statement_descriptor: nil,
  tax_code: nil,
  type: nil,
  unit_label: nil,
  url: nil
)
  @active = active
  @default_price_data = default_price_data
  @description = description
  @expand = expand
  @id = id
  @images = images
  @marketing_features = marketing_features
  @metadata = metadata
  @name = name
  @package_dimensions = package_dimensions
  @shippable = shippable
  @statement_descriptor = statement_descriptor
  @tax_code = tax_code
  @type = type
  @unit_label = unit_label
  @url = url
end

Instance Attribute Details

#active ⇒ Object

Whether the product is currently available for purchase. Defaults to ‘true`.



172
173
174
 
# File 'lib/stripe/params/product_create_params.rb', line 172

def active
  @active
end

#default_price_data ⇒ Object

Data used to generate a new [Price](stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.



174
175
176
 
# File 'lib/stripe/params/product_create_params.rb', line 174

def default_price_data
  @default_price_data
end

#description ⇒ Object

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.



176
177
178
 
# File 'lib/stripe/params/product_create_params.rb', line 176

def description
  @description
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



178
179
180
 
# File 'lib/stripe/params/product_create_params.rb', line 178

def expand
  @expand
end

#id ⇒ Object

An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.



180
181
182
 
# File 'lib/stripe/params/product_create_params.rb', line 180

def id
  @id
end

#images ⇒ Object

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



182
183
184
 
# File 'lib/stripe/params/product_create_params.rb', line 182

def images
  @images
end

#marketing_features ⇒ Object

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



184
185
186
 
# File 'lib/stripe/params/product_create_params.rb', line 184

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



186
187
188
 
# File 'lib/stripe/params/product_create_params.rb', line 186

def metadata
  @metadata
end

#name ⇒ Object

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



188
189
190
 
# File 'lib/stripe/params/product_create_params.rb', line 188

def name
  @name
end

#package_dimensions ⇒ Object

The dimensions of this product for shipping purposes.



190
191
192
 
# File 'lib/stripe/params/product_create_params.rb', line 190

def package_dimensions
  @package_dimensions
end

#shippable ⇒ Object

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



192
193
194
 
# File 'lib/stripe/params/product_create_params.rb', line 192

def shippable
  @shippable
end

#statement_descriptor ⇒ Object

An arbitrary string to be displayed on your customer’s credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.

This may be up to 22 characters. The statement description may not include ‘<`, `>`, ``, `“`, `’‘ characters, and will appear on your customer’s statement in capital letters. Non-ASCII characters are automatically stripped.

It must contain at least one letter. Only used for subscription payments.



197
198
199
 
# File 'lib/stripe/params/product_create_params.rb', line 197

def statement_descriptor
  @statement_descriptor
end

#tax_code ⇒ Object

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



199
200
201
 
# File 'lib/stripe/params/product_create_params.rb', line 199

def tax_code
  @tax_code
end

#type ⇒ Object

The type of the product. Defaults to ‘service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons.



201
202
203
 
# File 'lib/stripe/params/product_create_params.rb', line 201

def type
  @type
end

#unit_label ⇒ Object

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



203
204
205
 
# File 'lib/stripe/params/product_create_params.rb', line 203

def unit_label
  @unit_label
end

#url ⇒ Object

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



205
206
207
 
# File 'lib/stripe/params/product_create_params.rb', line 205

def url
  @url
end