Moov.Billing (Moov v1.0.0)

Copy Markdown View Source

Fee plans, fee plan agreements, statements, and per-account fees.

See https://docs.moov.io/api/moov-accounts/billing/.

Summary

Functions

Creates a fee plan agreement for an account. params includes :fee_plan_id.

Looks up fees for an account given a set of transfer-shaped criteria in params.

Retrieves a single billing statement.

Lists an account's fee plan agreements.

Lists fee plans available to an account.

Retrieves the fees that have been assessed against an account.

Lists an account's billing statements.

Functions

create_fee_plan_agreement(client, account_id, params)

@spec create_fee_plan_agreement(Moov.Client.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Creates a fee plan agreement for an account. params includes :fee_plan_id.

fetch_fees(client, account_id, params)

@spec fetch_fees(Moov.Client.t(), String.t(), map()) ::
  {:ok, [map()]} | {:error, Moov.Error.t()}

Looks up fees for an account given a set of transfer-shaped criteria in params.

get_statement(client, account_id, statement_id)

@spec get_statement(Moov.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Retrieves a single billing statement.

list_fee_plan_agreements(client, account_id, opts \\ [])

@spec list_fee_plan_agreements(Moov.Client.t(), String.t(), keyword()) ::
  {:ok, [map()]} | {:error, Moov.Error.t()}

Lists an account's fee plan agreements.

list_fee_plans(client, account_id, opts \\ [])

@spec list_fee_plans(Moov.Client.t(), String.t(), keyword()) ::
  {:ok, [map()]} | {:error, Moov.Error.t()}

Lists fee plans available to an account.

list_fees(client, account_id, opts \\ [])

@spec list_fees(Moov.Client.t(), String.t(), keyword()) ::
  {:ok, [map()]} | {:error, Moov.Error.t()}

Retrieves the fees that have been assessed against an account.

list_statements(client, account_id, opts \\ [])

@spec list_statements(Moov.Client.t(), String.t(), keyword()) ::
  {:ok, [map()]} | {:error, Moov.Error.t()}

Lists an account's billing statements.