Packages

dnsimple

7.0.0
10.0.0 9.0.0 8.3.0 8.2.0 8.1.0 8.0.0 7.0.1 7.0.0 6.0.1 6.0.0 5.0.1 5.0.0 4.0.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.1 3.1.1 3.1.0 3.0.2 3.0.1 3.0.0 2.0.0 1.4.1 1.4.0 1.3.0 1.2.0 1.1.1 1.1.0 1.0.1 1.0.0 0.9.2 0.9.1 0.9.0 0.1.0 0.0.1

Elixir client for the DNSimple API v2.

HexDocs

Current section

Files

Jump to
Readme
39 Versions
3 Dependencies
Dependants
Files
Activity
dnsimple lib dnsimple billing.ex
Raw

lib/dnsimple/billing.ex 

defmodule Dnsimple.Billing do

  @moduledoc """

  Provides functions to interact with the

  [billing endpoints](https://developer.dnsimple.com/v2/billing/).

  """

  @moduledoc section: :api



  alias Dnsimple.Client

  alias Dnsimple.Listing

  alias Dnsimple.Charge

  alias Dnsimple.Response



  @doc """

  Lists the billing charges the current authenticated entity has access to.



  See:

  - https://developer.dnsimple.com/v2/billing/#listCharges



  Examples:



      client = %Dnsimple.Client{access_token: "a1b2c3d4"}

      {:ok, response} = Dnsimple.Billing.list_charges(client, account_id = "1010")

      {:ok, response} = Dnsimple.Billing.list_charges(client, account_id = "1010", filter: [start_date: "2016-01-01", end_date: "2016-01-31"])

      {:ok, response} = Dnsimple.Billing.list_charges(client, account_id = "1010", page: 2, per_page: 10)

      {:ok, response} = Dnsimple.Billing.list_charges(client, account_id = "1010", sort: "invoiced:asc")



  """

  @spec list_charges(Client.t, String.t | integer, Keyword.t) :: {:ok|:error, Response.t}

  def list_charges(client, account_id, options \\ []) do

    url = Client.versioned("/#{account_id}/billing/charges")



    Listing.get(client, url, options)

    |> Response.parse(%{"data" => [%Charge{}], "pagination" => %Response.Pagination{}})

  end

end