Class: Stripe::V2::Billing::RateCards::RateService

Inherits:
StripeService
  • Object
show all
Defined in:
lib/stripe/services/v2/billing/rate_cards/rate_service.rb

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(rate_card_id, params = {}, opts = {}) ⇒ Object

Set the Rate for a Metered Item on the latest version of a Rate Card object. This will create a new Rate Card version if the Metered Item already has a rate on the Rate Card.



11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/stripe/services/v2/billing/rate_cards/rate_service.rb', line 11

def create(rate_card_id, params = {}, opts = {})
  unless params.is_a?(Stripe::RequestParams)
    params = ::Stripe::V2::Billing::RateCards::RateCreateParams.coerce_params(params)
  end

  request(
    method: :post,
    path: format("/v2/billing/rate_cards/%<rate_card_id>s/rates", { rate_card_id: CGI.escape(rate_card_id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#delete(rate_card_id, id, params = {}, opts = {}) ⇒ Object

Remove an existing Rate from a Rate Card. This will create a new Rate Card Version without that Rate.



26
27
28
29
30
31
32
33
34
 
# File 'lib/stripe/services/v2/billing/rate_cards/rate_service.rb', line 26

def delete(rate_card_id, id, params = {}, opts = {})
  request(
    method: :delete,
    path: format("/v2/billing/rate_cards/%<rate_card_id>s/rates/%<id>s", { rate_card_id: CGI.escape(rate_card_id), id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

List all Rates associated with a Rate Card for a specific version. Defaults to latest. Rates remain active for all subsequent versions until a new rate is created for the same Metered Item.



37
38
39
40
41
42
43
44
45
 
# File 'lib/stripe/services/v2/billing/rate_cards/rate_service.rb', line 37

def list(rate_card_id, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v2/billing/rate_cards/%<rate_card_id>s/rates", { rate_card_id: CGI.escape(rate_card_id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

Retrieve a Rate object.



48
49
50
51
52
53
54
55
56
 
# File 'lib/stripe/services/v2/billing/rate_cards/rate_service.rb', line 48

def retrieve(rate_card_id, id, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v2/billing/rate_cards/%<rate_card_id>s/rates/%<id>s", { rate_card_id: CGI.escape(rate_card_id), id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end