Class: Stripe::Billing::CreditGrantService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/billing/credit_grant_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(params = {}, opts = {}) ⇒ Object

Creates a credit grant.



8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 8

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

  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.



23
24
25
26
27
28
29
30
31
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 23

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.



34
35
36
37
38
39
40
41
42
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 34

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.



45
46
47
48
49
50
51
52
53
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 45

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.



56
57
58
59
60
61
62
63
64
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 56

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.



67
68
69
70
71
72
73
74
75
 
# File 'lib/stripe/services/billing/credit_grant_service.rb', line 67

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