class Stripe::Product

• Stripe::Product
• Reference
• Object

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

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

stripe/models/product.cr

Constant Summary

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(*, 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 Method Summary

• #==(other : self)

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

• #_type : String | Nil
• #_type=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #active : Bool | Nil
• #active=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #default_price_present=(default_price_present : Bool)
• #default_price_present? : Bool
• #description : String | Nil
• #description=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #name : String | Nil
• #name=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #shippable : Bool | Nil
• #shippable=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #statement_descriptor : String | Nil
• #statement_descriptor=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #statement_descriptor_present=(statement_descriptor_present : Bool)
• #statement_descriptor_present? : Bool
• #tax_code : Stripe::ProductTaxCode | Nil
• #tax_code=(new_value : Stripe::ProductTaxCode | Nil)

  Custom attribute writer method checking allowed values (enum).

• #unit_label : String | Nil
• #unit_label=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #unit_label_present=(unit_label_present : Bool)
• #unit_label_present? : Bool
• #updated : Int64 | Nil
• #updated=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #url : String | Nil
• #url=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

Constructor Detail

Instance Method Detail