Class: Billingrails::Resources::Subscriptions

Inherits:
Object
  • Object
show all
Defined in:
lib/billingrails/resources/subscriptions.rb

Overview

Subscriptions resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Subscriptions

Returns a new instance of Subscriptions.

Parameters:

  • client (Client) —

    The API client



10
11
12
 
# File 'lib/billingrails/resources/subscriptions.rb', line 10

def initialize(client)
  @client = client
end

Instance Method Details

#create(data) ⇒ Hash

Create a subscription

Creates a subscription.

Parameters:

  • data (Hash) —

    Request body

Returns:

  • (Hash) —

    Response data



55
56
57
58
 
# File 'lib/billingrails/resources/subscriptions.rb', line 55

def create(data)
  path = "/biller/subscriptions"
  @client.request(:post, path, body: data)
end

#list(params: nil) ⇒ Hash

List subscriptions

Retrieves a list of subscriptions.

Parameters:

  • params (Hash, nil) (defaults to: nil) —

    Query parameters

Returns:

  • (Hash) —

    Response data



44
45
46
47
 
# File 'lib/billingrails/resources/subscriptions.rb', line 44

def list(params: nil)
  path = "/biller/subscriptions"
  @client.request(:get, path, params: params)
end

#retrieve(id, params: nil) ⇒ Hash

Retrieve subscription

Retrieves a subscription by ID.

Parameters:

  • id (String) —

    Resource ID

  • params (Hash, nil) (defaults to: nil) —

    Query parameters

Returns:

  • (Hash) —

    Response data



21
22
23
24
 
# File 'lib/billingrails/resources/subscriptions.rb', line 21

def retrieve(id, params: nil)
  path = "/biller/subscriptions/#{id}"
  @client.request(:get, path, params: params)
end

#update(id, data) ⇒ Hash

Update a subscription

Updates a subscription.

Parameters:

  • id (String) —

    Resource ID

  • data (Hash) —

    Request body

Returns:

  • (Hash) —

    Response data



33
34
35
36
 
# File 'lib/billingrails/resources/subscriptions.rb', line 33

def update(id, data)
  path = "/biller/subscriptions/#{id}"
  @client.request(:put, path, body: data)
end