Moov.PartnerBilling (Moov v1.0.0)

Copy Markdown View Source

Residuals, fee revenue, and pricing agreements for partner accounts (platforms/SaaS/marketplaces). account_id here must be your partner account ID, found under Dashboard -> Settings - not a regular merchant account ID.

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

Summary

Functions

Retrieves a single residual.

Lists fee revenue for a partner account.

Lists the fees that make up a residual.

Lists residuals for a partner account.

Functions

get_residual(client, account_id, residual_id)

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

Retrieves a single residual.

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

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

Lists fee revenue for a partner account.

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

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

Lists partner pricing agreements.

list_residual_fees(client, account_id, residual_id, opts \\ [])

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

Lists the fees that make up a residual.

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

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

Lists residuals for a partner account.