Preview the employee seat charge

Preview the prorated per-seat amount for activating or hiring employees, computed from the Stripe upcoming invoice of the employee-seats subscription, without charging.

Use count (≥1, up to 1000) for a batch preview, or employee_ids (UUID v7) for a coverage-aware preview: employees still covered for the current period cost 0 (already_covered: true).
amount is the taxable base in cents; requires_payment_method is true when no payment method is on file.
Never throws — it degrades to a neutral preview.

Query Parameters

count?|

Number of employees that would be activated in bulk (at least 1, default 1).

Range1 <= value <= 1000

employee_ids[]?array<string>

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.

Formatdate

X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Response Body

`application/json`

Request example

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/employee-seats/preview", {  method: "GET",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json"} },});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Response example

{
  "data": {
    "object": "employee_seat_charge_preview",
    "amount": 75,
    "tax_amount": 16,
    "total": 91,
    "tax_rate": 21,
    "currency": "EUR",
    "next_invoice_date": "2026-08-01T09:12:00+00:00",
    "requires_payment_method": false,
    "requires_active_plan": false,
    "included_in_trial": false,
    "already_covered": false,
    "is_first_seat": false,
    "recurring_quantity": 5,
    "recurring_base_cents": 750,
    "recurring_total_cents": 908,
    "seats_billable": true
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_87661e34b9b723faf35f780aad"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'employees:read'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_8578a2978dffb90943ac1937be"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "El campo count no tiene un valor válido.",
    "param": "count",
    "errors": [
      {
        "param": "count",
        "code": "parameter_invalid_value",
        "message": "El campo count no tiene un valor válido."
      }
    ],
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_530d3c4249b0cecf16c800cf26"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_7c4d7fb2a9cf3db78f22cff118"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_48725d5c62477ce2fbec0e8e46"
  }
}

Preview the employee seat charge

Authorization

Query Parameters

Headers

Response Body

200application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`