Class: Stripe::PriceService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/price_service.rb

Defined Under Namespace

Classes: CreateParams, ListParams, RetrieveParams, SearchParams, UpdateParams

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

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



519
520
521
 
# File 'lib/stripe/services/price_service.rb', line 519

def create(params = {}, opts = {})
  request(method: :post, path: "/v1/prices", params: params, opts: opts, base_address: :api)
end

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

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



524
525
526
 
# File 'lib/stripe/services/price_service.rb', line 524

def list(params = {}, opts = {})
  request(method: :get, path: "/v1/prices", params: params, opts: opts, base_address: :api)
end

#retrieve(price, params = {}, opts = {}) ⇒ Object

Retrieves the price with the given ID.



529
530
531
532
533
534
535
536
537
 
# File 'lib/stripe/services/price_service.rb', line 529

def retrieve(price, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v1/prices/%<price>s", { price: CGI.escape(price) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

Search for prices you’ve previously created using Stripe’s [Search Query Language](stripe.com/docs/search#search-query-language). Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.



543
544
545
546
547
548
549
550
551
 
# File 'lib/stripe/services/price_service.rb', line 543

def search(params = {}, opts = {})
  request(
    method: :get,
    path: "/v1/prices/search",
    params: params,
    opts: opts,
    base_address: :api
  )
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.



554
555
556
557
558
559
560
561
562
 
# File 'lib/stripe/services/price_service.rb', line 554

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