class

Stripe::Product

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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 to configure pricing in Payment Links, Checkout, and Subscriptions. Related guides: Set up a subscription, share a Payment Link, accept payments with Checkout, and more about Products and Prices

Constants

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [good, service]."

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [product]."

MAX_LENGTH_FOR_DESCRIPTION = 5000

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_NAME = 5000

MAX_LENGTH_FOR_STATEMENT_DESCRIPTOR = 5000

MAX_LENGTH_FOR_UNIT_LABEL = 5000

MAX_LENGTH_FOR_URL = 2048

VALID_VALUES_FOR__TYPE = String.static_array("good", "service")

VALID_VALUES_FOR_OBJECT = String.static_array("product")

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, active : Bool | Nil = nil, created : Int64 | Nil = nil, description : String | Nil = nil, id : String | Nil = nil, images : Array(String) | Nil = nil, livemode : Bool | Nil = nil, marketing_features : Array(Stripe::ProductMarketingFeature) | Nil = nil, metadata : Hash(String, String) | Nil = nil, name : String | Nil = nil, object : String | Nil = nil, package_dimensions : Stripe::ProductPackageDimensions | Nil = nil, shippable : Bool | Nil = nil, tax_code : Stripe::ProductTaxCode | Nil = nil, _type : String | Nil = nil, updated : Int64 | Nil = nil, url : String | Nil = nil, default_price : Stripe::ProductDefaultPrice | Nil = nil, statement_descriptor : String | Nil = nil, unit_label : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

_type

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.

_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned

active

Whether the product is currently available for purchase.

active=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] active Object to be assigned

created

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

created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

default_price

default_price=(new_value : Stripe::ProductDefaultPrice | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] default_price Object to be assigned

default_price_present=(default_price_present : Bool)

default_price_present?

description

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.

description=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

images

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

images=(new_value : Array(String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] images Object to be assigned

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

marketing_features

A list of up to 15 marketing features for this product. These are displayed in pricing tables.

marketing_features=(new_value : Array(Stripe::ProductMarketingFeature) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] marketing_features Object to be assigned

metadata

metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

name

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

name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] name Object to be assigned

object

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

object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

package_dimensions

package_dimensions=(new_value : Stripe::ProductPackageDimensions | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] package_dimensions Object to be assigned

shippable

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

shippable=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] shippable Object to be assigned

statement_descriptor

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.

statement_descriptor=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] statement_descriptor Object to be assigned

statement_descriptor_present=(statement_descriptor_present : Bool)

statement_descriptor_present?

tax_code

tax_code=(new_value : Stripe::ProductTaxCode | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] tax_code Object to be assigned

unit_label

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

unit_label=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] unit_label Object to be assigned

unit_label_present=(unit_label_present : Bool)

unit_label_present?

updated

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

updated=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] updated Object to be assigned

url

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

url=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] url Object to be assigned

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid