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

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

Defined Under Namespace

Classes: CreateParams, DeleteParams, ListParams, RetrieveParams

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.



115
116
117
118
119
120
121
122
123
 
# File 'lib/stripe/services/v2/billing/rate_cards/rate_service.rb', line 115

def create(rate_card_id, params = {}, opts = {})
  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.



126
127
128
129
130
131
132
133
134
 
# File 'lib/stripe/services/v2/billing/rate_cards/rate_service.rb', line 126

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.



137
138
139
140
141
142
143
144
145
 
# File 'lib/stripe/services/v2/billing/rate_cards/rate_service.rb', line 137

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.



148
149
150
151
152
153
154
155
156
 
# File 'lib/stripe/services/v2/billing/rate_cards/rate_service.rb', line 148

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