Class: Billingrails::Resources::Charges

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

Overview

Charges resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Charges

Returns a new instance of Charges.

Parameters:

  • client (Client) —

    The API client



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

def initialize(client)
  @client = client
end

Instance Method Details

#discard(id) ⇒ Hash

Discard a charge

Discards a ‘ready`charge.

Parameters:

  • id (String) —

    Resource ID

Returns:

  • (Hash) —

    Response data



31
32
33
34
 
# File 'lib/billingrails/resources/charges.rb', line 31

def discard(id)
  path = "/charges/#{id}"
  @client.request(:delete, path)
end

#settle(id) ⇒ Hash

Settle a charge

Marks a charge in ‘ready` status as settled. Typically used when confirming usage outside automatic credit settlement.

Parameters:

  • id (String) —

    Resource ID

Returns:

  • (Hash) —

    Response data



20
21
22
23
 
# File 'lib/billingrails/resources/charges.rb', line 20

def settle(id)
  path = "/charges/#{id}/settle"
  @client.request(:post, path)
end