Skip to main content
GET
Get a merchant's billing pause

Authorizations

Authorization
string
header
required

Merchant API key (fp_live_* for live, fp_test_* for sandbox) or an admin-tier JWT (company admin or root admin). Non-admin JWTs are rejected with 403; live API keys additionally require the merchant's API access to be enabled.

A company admin, company token or partner token also needs the role grant for the action, or gets 403: gateways.view, .create, .update or .delete (or the matching apm.* grant) for gateway configuration, transactions.update for purchase, authorize, verify, capture, void and credit, and transactions.view to read transactions. API keys, root admins and droplet tokens are not checked against roles.

Path Parameters

merchant_id
integer
required

Company ID of the merchant. The lookup resolves by company ID only, the same as the configuration endpoint.

Response

The merchant's billing pause state

data
object
required

Whether Fluid is collecting money from this merchant's customers.

meta
object
required