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](stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.

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

Defined Under Namespace

Classes: CreateParams, DeleteParams, ListParams, MarketingFeature, PackageDimensions, Provisioning, RetrieveParams, SearchParams, UpdateParams

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

#==, #[], #[]=, 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

#active ⇒ Object (readonly)

Whether the product is currently available for purchase.



602
603
604
 
# File 'lib/stripe/resources/product.rb', line 602

def active
  @active
end

#created ⇒ Object (readonly)

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



605
606
607
 
# File 'lib/stripe/resources/product.rb', line 605

def created
  @created
end

#default_price ⇒ Object (readonly)

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



608
609
610
 
# File 'lib/stripe/resources/product.rb', line 608

def default_price
  @default_price
end

#deleted ⇒ Object (readonly)

Always true for a deleted object



662
663
664
 
# File 'lib/stripe/resources/product.rb', line 662

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.



611
612
613
 
# File 'lib/stripe/resources/product.rb', line 611

def description
  @description
end

#id ⇒ Object (readonly)

Unique identifier for the object.



614
615
616
 
# File 'lib/stripe/resources/product.rb', line 614

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.



617
618
619
 
# File 'lib/stripe/resources/product.rb', line 617

def images
  @images
end

#livemode ⇒ Object (readonly)

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



620
621
622
 
# File 'lib/stripe/resources/product.rb', line 620

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](stripe.com/docs/payments/checkout/pricing-table).



623
624
625
 
# File 'lib/stripe/resources/product.rb', line 623

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



626
627
628
 
# File 'lib/stripe/resources/product.rb', line 626

def metadata
  @metadata
end

#name ⇒ Object (readonly)

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



629
630
631
 
# File 'lib/stripe/resources/product.rb', line 629

def name
  @name
end

#object ⇒ Object (readonly)

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



632
633
634
 
# File 'lib/stripe/resources/product.rb', line 632

def object
  @object
end

#package_dimensions ⇒ Object (readonly)

The dimensions of this product for shipping purposes.



635
636
637
 
# File 'lib/stripe/resources/product.rb', line 635

def package_dimensions
  @package_dimensions
end

#provisioning ⇒ Object (readonly)

Provisioning configuration for this product.



638
639
640
 
# File 'lib/stripe/resources/product.rb', line 638

def provisioning
  @provisioning
end

#shippable ⇒ Object (readonly)

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



641
642
643
 
# File 'lib/stripe/resources/product.rb', line 641

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.



644
645
646
 
# File 'lib/stripe/resources/product.rb', line 644

def statement_descriptor
  @statement_descriptor
end

#tax_code ⇒ Object (readonly)

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



647
648
649
 
# File 'lib/stripe/resources/product.rb', line 647

def tax_code
  @tax_code
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.



650
651
652
 
# File 'lib/stripe/resources/product.rb', line 650

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.



653
654
655
 
# File 'lib/stripe/resources/product.rb', line 653

def unit_label
  @unit_label
end

#updated ⇒ Object (readonly)

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



656
657
658
 
# File 'lib/stripe/resources/product.rb', line 656

def updated
  @updated
end

#url ⇒ Object (readonly)

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



659
660
661
 
# File 'lib/stripe/resources/product.rb', line 659

def url
  @url
end

Class Method Details

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

Creates a new product object.



665
666
667
 
# File 'lib/stripe/resources/product.rb', line 665

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.



670
671
672
673
674
675
676
677
 
# File 'lib/stripe/resources/product.rb', line 670

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

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



690
691
692
 
# File 'lib/stripe/resources/product.rb', line 690

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 



694
695
696
 
# File 'lib/stripe/resources/product.rb', line 694

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 



698
699
700
 
# File 'lib/stripe/resources/product.rb', line 698

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.



703
704
705
706
707
708
709
710
 
# File 'lib/stripe/resources/product.rb', line 703

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.



680
681
682
683
684
685
686
687
 
# File 'lib/stripe/resources/product.rb', line 680

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