Ramp.Statements (ramp v1.0.0)

Copy Markdown View Source

The Statements resource: read-only access to monthly billing statements.

Summary

Functions

Fetches a single statement by ID.

Returns a lazily auto-paginating Stream of Ramp.Statements.Statements.

Fetches a single page of statements. See Ramp.Page.

Types

list_opt()

@type list_opt() ::
  {:start, String.t()} | {:page_size, pos_integer()} | {:entity_id, String.t()}

Functions

get(client, id)

@spec get(Ramp.Client.t(), String.t()) ::
  {:ok, Ramp.Statements.Statement.t()} | {:error, Ramp.Error.t()}

Fetches a single statement by ID.

list(client, opts \\ [])

Returns a lazily auto-paginating Stream of Ramp.Statements.Statements.

list_page(client, opts \\ [])

@spec list_page(Ramp.Client.t(), [list_opt()]) ::
  {:ok, Ramp.Page.t(Ramp.Statements.Statement.t())} | {:error, Ramp.Error.t()}

Fetches a single page of statements. See Ramp.Page.