Flint billing

Flint billing is what you owe Flint and any account credit you hold against it: per-event fees, Flint's subscription charges to you, corrections to fees already charged, credit Flint issues you, and the collections Flint takes out of your Flint balance. It is separate from subscriptions, which is you charging your own customers.

A merchant billing balance is one currency's current position: outstanding_money is what you owe now, available_credit_money is credit you hold and have not used, and observed_at is when the snapshot was taken. Both amounts are unsigned, and credit reduces what you owe only when Flint applies it. merchant_billing_balance_id is stable per currency, so you can fetch the same balance again by ID.

A merchant subscription invoice is an invoice Flint issued to you. subtotal_money is the amount before credit, credit_money is the credit applied to it, total_money is subtotal minus credit, and outstanding_money is what is left to collect. Lines are subscription or credit.

Flint collects what you owe out of your Flint balance, which posts a merchant_billing_payment balance transaction with a negative amount and no fee. A reversed collection posts a merchant_billing_payment_reversal with a positive amount, whose related_balance_transaction_ids holds the ID of the collection it reverses. Both appear on money movement, and a collection made against a Flint invoice can be found with GET /v1/balance-transactions?related_object_type=merchant_subscription_invoice.

These routes are read-only and need the merchant_billing.read scope. For entry-by-entry history, generate the merchant_billing_itemized_v1 report. See Flint Billing for the eight entry types and their signed effects.

List merchant billing balances#

GET/v1/merchant-billing-balancesRequires scope: merchant_billing.read

Returns what the merchant currently owes Flint and owns as account credit by currency.

Query parameters
page_sizeinteger

Page size, default 20, max 100.

page_tokenstring

Cursor returned by the previous response.

Response · 200
dataarray of objectrequired
metaobject
next_page_tokenstring
request_idstring

Error codes

AUTH_REQUIREDINSUFFICIENT_SCOPEINTERNAL_ERRORINVALID_REQUESTRATE_LIMIT_EXCEEDED
Bash
curl https://api.withflintpay.com/v1/merchant-billing-balances \
  -H "Authorization: Bearer YOUR_API_KEY"

Get a merchant billing balance#

GET/v1/merchant-billing-balances/{merchant_billing_balance_id}Requires scope: merchant_billing.read

Returns what the merchant currently owes Flint and owns as account credit in one currency.

Path parameters
merchant_billing_balance_idstringrequired

Flint merchant billing balance ID.

Response · 200
dataobjectrequired

Current Flint merchant billing balance for one billing account and currency.

metaobject
request_idstring

Error codes

AUTH_REQUIREDINSUFFICIENT_SCOPEINTERNAL_ERRORINVALID_REQUESTRATE_LIMIT_EXCEEDEDRESOURCE_NOT_FOUND
Bash
curl https://api.withflintpay.com/v1/merchant-billing-balances/{merchant_billing_balance_id} \
  -H "Authorization: Bearer YOUR_API_KEY"

List merchant subscription invoices#

GET/v1/merchant-subscription-invoicesRequires scope: merchant_billing.read

Returns invoices issued by Flint for the authenticated merchant environment.

Query parameters
page_sizeinteger

Page size, default 20, max 100.

page_tokenstring

Cursor returned by the previous response.

Response · 200
dataarray of objectrequired
metaobject
next_page_tokenstring
request_idstring

Error codes

AUTH_REQUIREDINSUFFICIENT_SCOPEINTERNAL_ERRORINVALID_REQUESTRATE_LIMIT_EXCEEDED
Bash
curl https://api.withflintpay.com/v1/merchant-subscription-invoices \
  -H "Authorization: Bearer YOUR_API_KEY"

Get a merchant subscription invoice#

GET/v1/merchant-subscription-invoices/{merchant_subscription_invoice_id}Requires scope: merchant_billing.read

Returns one invoice issued by Flint for the authenticated merchant environment.

Path parameters
merchant_subscription_invoice_idstringrequired

Flint merchant subscription invoice ID.

Response · 200
dataobjectrequired
metaobject
request_idstring

Error codes

AUTH_REQUIREDINSUFFICIENT_SCOPEINTERNAL_ERRORINVALID_REQUESTRATE_LIMIT_EXCEEDEDRESOURCE_NOT_FOUND
Bash
curl https://api.withflintpay.com/v1/merchant-subscription-invoices/{merchant_subscription_invoice_id} \
  -H "Authorization: Bearer YOUR_API_KEY"
Rate this doc