Class: Stripe::Billing::CreditGrantService

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

Defined Under Namespace

Classes: CreateParams, ExpireParams, ListParams, RetrieveParams, UpdateParams, VoidGrantParams

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



170
171
172
173
174
175
176
177
178
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 170

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

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

Expires a credit grant.



181
182
183
184
185
186
187
188
189
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 181

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

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

Retrieve a list of credit grants.



192
193
194
195
196
197
198
199
200
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 192

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

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

Retrieves a credit grant.



203
204
205
206
207
208
209
210
211
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 203

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

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

Updates a credit grant.



214
215
216
217
218
219
220
221
222
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 214

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

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

Voids a credit grant.



225
226
227
228
229
230
231
232
233
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 225

def void_grant(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/billing/credit_grants/%<id>s/void", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end