---
title: "Preview the employee seat charge"
method: GET
path: "/accounts/{account}/employee-seats/preview"
tags: ["Employees"]
---

# Preview the employee seat charge

`GET /accounts/{account}/employee-seats/preview`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/accounts/{account}/employee-seats/preview`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Preview the prorated per-seat charge for activating or hiring employees, without charging.
- Send `count` (1 to 1000) or `employee_ids` (UUID v7); already covered employees cost 0.
- Amounts are 2-decimal euro strings; 403 `billing_managed_by_provider` when the provider manages billing.

## Path parameters

- `account` string, uuid, required

## Query parameters

- `count` integer, nullable
- `employee_ids[]` string[]

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object
  - `data` EmployeeSeatChargePreview, required: Preview of the prorated per-seat charge for activating or hiring employees, computed from the Stripe upcoming invoice without charging. The exclusive reason flags for a 0 amount, by precedence: `already_covered` > `requires_active_plan` > `included_in_trial`. At most one is true. `requires_payment_method` is NOT a 0-amount branch: it flags an obstacle on a REAL amount. Read `seats_billable` before promising a charge: when false the operation never bills (enterprise by contract, trial, sandbox or live mode off) even though the amount is computed. `amount`, `tax_amount` and `total` are euro 2-decimal strings; `recurring_base_cents` and `recurring_total_cents` stay in cents, as their names state.
    - `object` 'employee_seat_charge_preview', required: Stripe-like discriminator. Always `employee_seat_charge_preview` for this resource.
    - `amount` string, required: Taxable base of the proration (without VAT), in euros as a 2-decimal string.
    - `tax_amount` string, required: VAT amount of the proration, in euros as a 2-decimal string.
    - `total` string, required: Total actually charged (`amount + tax_amount`), in euros as a 2-decimal string.
    - `tax_rate` integer, nullable, required: Applied VAT rate (e.g. 21), or null when Stripe Tax did not resolve it (then `tax_amount` is 0 and `total` = `amount`).
    - `currency` string, required: ISO 4217 currency code (uppercase).
    - `next_invoice_date` string, date-time, nullable, required: End of the current period of the seat subscription (ISO 8601), never today; null when not resolvable.
    - `requires_payment_method` boolean, required: true when the company operates in live mode with no payment method on file. This does NOT zero the amount: the proration is still computed (previewing it needs no card), so you can show what the operation will cost before asking for the card. Configure the payment method to proceed.
    - `requires_active_plan` boolean, required: true when the company has no active paid plan (amount is 0).
    - `included_in_trial` boolean, required: true when the company is on trial, so the activation is free (amount is 0) until the trial converts to a paid plan.
    - `already_covered` boolean, required: true when every employee to activate is still covered this period (free reactivation, amount is 0).
    - `is_first_seat` boolean, required: true when the activation creates the FIRST seat subscription of the company (full-month charge that anchors the monthly billing day).
    - `recurring_quantity` integer, nullable, required: Projected total seat quantity (current + new) of the joint monthly cost after activation, or null on reason branches.
    - `recurring_base_cents` integer, nullable, required: Base (without VAT) of the projected joint monthly cost, in cents, or null.
    - `recurring_total_cents` integer, nullable, required: Projected joint monthly cost with VAT, in cents; null when VAT is not calculable.
    - `seats_billable` boolean, required: true when the seat WILL actually be billed: the very same predicate the hiring/reactivation gate uses (live paid plan, company not in sandbox) and the same field `GET /v1/accounts/{account}/employee-seats` exposes. When false the operation never charges (enterprise by contract, trial, sandbox or live mode off) even though `amount` is computed — do not present it as a payment, and do not ask for confirmation of a charge that will not happen. Independent of the 0-amount branches: it can be true together with `already_covered` (the plan does bill seats, but THIS operation is free).

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company. `account_not_found`: the account in the path does not exist or is not the account of the API key.
- `422`: Validation failed. The `error.param` field identifies which input is invalid.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)