Class: Stripe::V2::Billing::ContractService

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from StripeService

#request, #request_stream

Constructor Details

#initialize(requestor) ⇒ ContractService

Returns a new instance of ContractService.



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

def initialize(requestor)
  super
  @pricing_lines = Stripe::V2::Billing::Contracts::PricingLinesService.new(@requestor)
end

Instance Attribute Details

#pricing_lines ⇒ Object (readonly)

Returns the value of attribute pricing_lines.



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

def pricing_lines
  @pricing_lines
end

Instance Method Details

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

Activate a draft contract.



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

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

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

Cancel an active contract.



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

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

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

Create a draft contract.



38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/stripe/services/v2/billing/contract_service.rb', line 38

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

  request(
    method: :post,
    path: "/v2/billing/contracts",
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

Delete a draft contract.



53
54
55
56
57
58
59
60
61
 
# File 'lib/stripe/services/v2/billing/contract_service.rb', line 53

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

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

List contracts.



64
65
66
67
68
69
70
71
72
 
# File 'lib/stripe/services/v2/billing/contract_service.rb', line 64

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

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

Retrieve a contract.



75
76
77
78
79
80
81
82
83
 
# File 'lib/stripe/services/v2/billing/contract_service.rb', line 75

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

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

Update a draft or active contract.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/stripe/services/v2/billing/contract_service.rb', line 86

def update(id, params = {}, opts = {})
  unless params.is_a?(Stripe::RequestParams)
    params = ::Stripe::V2::Billing::ContractUpdateParams.coerce_params(params)
  end

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