Class: Stripe::V2::Billing::CadenceService

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from StripeService

#request, #request_stream

Constructor Details

#initialize(requestor) ⇒ CadenceService

Returns a new instance of CadenceService.



10
11
12
13
14
# File 'lib/stripe/services/v2/billing/cadence_service.rb', line 10

def initialize(requestor)
  super
  @spend_modifier_rules = Stripe::V2::Billing::Cadences::SpendModifierRuleService
                          .new(@requestor)
end

Instance Attribute Details

#spend_modifier_rulesObject (readonly)

Returns the value of attribute spend_modifier_rules.



8
9
10
# File 'lib/stripe/services/v2/billing/cadence_service.rb', line 8

def spend_modifier_rules
  @spend_modifier_rules
end

Instance Method Details

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

Cancel the Billing Cadence.



17
18
19
20
21
22
23
24
25
# File 'lib/stripe/services/v2/billing/cadence_service.rb', line 17

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

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

Create a Billing Cadence object.



28
29
30
31
32
33
34
35
36
# File 'lib/stripe/services/v2/billing/cadence_service.rb', line 28

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

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

List Billing Cadences.



39
40
41
42
43
44
45
46
47
# File 'lib/stripe/services/v2/billing/cadence_service.rb', line 39

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

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

Retrieve a Billing Cadence object.



50
51
52
53
54
55
56
57
58
# File 'lib/stripe/services/v2/billing/cadence_service.rb', line 50

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

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

Update a Billing Cadence object.



61
62
63
64
65
66
67
68
69
# File 'lib/stripe/services/v2/billing/cadence_service.rb', line 61

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