Preview the seat charge of adding a company
Preview the prorated amount of registering or activating ADDITIONAL tax IDs, without charging.
- Use count for a batch or company_ids for a coverage-aware preview; covered tax IDs cost 0.
- Amounts are 2-decimal euro strings; this read never returns 402 or plan and cap rejections.
- Returns 403 billing_managed_by_provider when a provider manages billing.
Request
- Base URL: https://api.factuarea.com/v1
- URL: https://api.factuarea.com/v1/accounts/{account}/companies/seat-charge-preview
- Auth: one of:
- HTTP bearer
- API key in header X-API-Key
Path parameters
Public identifier (UUID v7) of your account. Get it from GET /v1/me (data.account.id).
Query parameters
Number of companies to preview activating in bulk, between 1 and 1000 (default 1); used without company_ids[].
Public identifiers (UUID v7) of the companies to preview; omit it to preview count companies.
Headers
Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.
Response
Preview the charge of the additional tax IDs (seats) of the account without creating a company or charging a payment method. amount, tax_amount and total are euro 2-decimal strings; recurring_base_cents and recurring_total_cents stay in cents, as their names state.
Example response
{
"data": {
"amount": "7.50",
"tax_amount": "1.58",
"total": "9.08"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.