Class: Stripe::Price

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

Overview

Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. [Products](stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.

For example, you might have a single “gold” product that has prices for $10/month, $100/year, and €9 once.

Related guides: [Set up a subscription](stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](stripe.com/docs/billing/invoices/create), and more about [products and prices](stripe.com/docs/products-prices/overview).

Defined Under Namespace

Classes: CreateParams, CurrencyOptions, CustomUnitAmount, ListParams, MigrateTo, Recurring, SearchParams, Tier, TransformQuantity, UpdateParams

Constant Summary collapse

OBJECT_NAME = 
"price"

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

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Search

_search

Methods included from APIOperations::Save

included, #save

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 price can be used for new purchases.



610
611
612
 
# File 'lib/stripe/resources/price.rb', line 610

def active
  @active
end

#billing_scheme ⇒ Object (readonly)

Describes how to compute the price per period. Either ‘per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.



612
613
614
 
# File 'lib/stripe/resources/price.rb', line 612

def billing_scheme
  @billing_scheme
end

#created ⇒ Object (readonly)

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



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

def created
  @created
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



616
617
618
 
# File 'lib/stripe/resources/price.rb', line 616

def currency
  @currency
end

#currency_options ⇒ Object (readonly)

Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html) and a [supported currency](stripe.com/docs/currencies).



618
619
620
 
# File 'lib/stripe/resources/price.rb', line 618

def currency_options
  @currency_options
end

#custom_unit_amount ⇒ Object (readonly)

When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.



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

def custom_unit_amount
  @custom_unit_amount
end

#deleted ⇒ Object (readonly)

Always true for a deleted object



654
655
656
 
# File 'lib/stripe/resources/price.rb', line 654

def deleted
  @deleted
end

#id ⇒ Object (readonly)

Unique identifier for the object.



622
623
624
 
# File 'lib/stripe/resources/price.rb', line 622

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



624
625
626
 
# File 'lib/stripe/resources/price.rb', line 624

def livemode
  @livemode
end

#lookup_key ⇒ Object (readonly)

A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.



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

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



628
629
630
 
# File 'lib/stripe/resources/price.rb', line 628

def metadata
  @metadata
end

#migrate_to ⇒ Object (readonly)

Subscriptions using this price will be migrated to use the new referenced price.



630
631
632
 
# File 'lib/stripe/resources/price.rb', line 630

def migrate_to
  @migrate_to
end

#nickname ⇒ Object (readonly)

A brief description of the price, hidden from customers.



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

def nickname
  @nickname
end

#object ⇒ Object (readonly)

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



634
635
636
 
# File 'lib/stripe/resources/price.rb', line 634

def object
  @object
end

#product ⇒ Object (readonly)

The ID of the product this price is associated with.



636
637
638
 
# File 'lib/stripe/resources/price.rb', line 636

def product
  @product
end

#recurring ⇒ Object (readonly)

The recurring components of a price such as ‘interval` and `usage_type`.



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

def recurring
  @recurring
end

#tax_behavior ⇒ Object (readonly)

Only required if a [default tax behavior](stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of ‘inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.



640
641
642
 
# File 'lib/stripe/resources/price.rb', line 640

def tax_behavior
  @tax_behavior
end

#tiers ⇒ Object (readonly)

Each element represents a pricing tier. This parameter requires ‘billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.



642
643
644
 
# File 'lib/stripe/resources/price.rb', line 642

def tiers
  @tiers
end

#tiers_mode ⇒ Object (readonly)

Defines if the tiering price should be ‘graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.



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

def tiers_mode
  @tiers_mode
end

#transform_quantity ⇒ Object (readonly)

Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with ‘tiers`.



646
647
648
 
# File 'lib/stripe/resources/price.rb', line 646

def transform_quantity
  @transform_quantity
end

#type ⇒ Object (readonly)

One of ‘one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.



648
649
650
 
# File 'lib/stripe/resources/price.rb', line 648

def type
  @type
end

#unit_amount ⇒ Object (readonly)

The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if ‘billing_scheme=per_unit`.



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

def unit_amount
  @unit_amount
end

#unit_amount_decimal ⇒ Object (readonly)

The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if ‘billing_scheme=per_unit`.



652
653
654
 
# File 'lib/stripe/resources/price.rb', line 652

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

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

Creates a new [Price for an existing <a href=“docs.stripe.com/api/products”>Product](docs.stripe.com/api/prices). The Price can be recurring or one-time.



657
658
659
 
# File 'lib/stripe/resources/price.rb', line 657

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

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

Returns a list of your active prices, excluding [inline prices](docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.



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

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

.object_name ⇒ Object 



18
19
20
 
# File 'lib/stripe/resources/price.rb', line 18

def self.object_name
  "price"
end

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



666
667
668
 
# File 'lib/stripe/resources/price.rb', line 666

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

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



670
671
672
 
# File 'lib/stripe/resources/price.rb', line 670

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

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

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.



675
676
677
678
679
680
681
682
 
# File 'lib/stripe/resources/price.rb', line 675

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