Skip to main content
POST
Stop collecting money from this merchant's customers

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.

Path Parameters

merchant_id
integer
required

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

Body

application/json
billing_pause
object
required

Response

The merchant's billing pause state

data
object
required

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

meta
object
required