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.



174
175
176
177
178
179
180
181
182
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 174

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.



185
186
187
188
189
190
191
192
193
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 185

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.



196
197
198
199
200
201
202
203
204
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 196

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.



207
208
209
210
211
212
213
214
215
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 207

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.



218
219
220
221
222
223
224
225
226
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 218

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.



229
230
231
232
233
234
235
236
237
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 229

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