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

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

Defined Under Namespace

Classes: CancelParams, CreateParams, ListParams, RetrieveParams, UpdateParams

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

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

Cancel the Billing Cadence.



372
373
374
375
376
377
378
379
380
 
# File 'lib/stripe/services/v2/billing/cadence_service.rb', line 372

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.



383
384
385
386
387
388
389
390
391
 
# File 'lib/stripe/services/v2/billing/cadence_service.rb', line 383

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.



394
395
396
397
398
399
400
401
402
 
# File 'lib/stripe/services/v2/billing/cadence_service.rb', line 394

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.



405
406
407
408
409
410
411
412
413
 
# File 'lib/stripe/services/v2/billing/cadence_service.rb', line 405

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.



416
417
418
419
420
421
422
423
424
 
# File 'lib/stripe/services/v2/billing/cadence_service.rb', line 416

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