Preview a change of the additional tax ID seats

Preview, without charging or writing, setting the contracted additional tax ID seats to contracted_seats. - A purchase returns the amount charged today; a reduction returns 0.00, the pending_reduction, deactivations_required and the offer_package_loss. - Amounts are 2-decimal euro strings; above the account cap it returns 422 additional_nif_limit_reached. - 403 billing_managed_by_provider when the provider manages billing.

Authorization

AuthorizationBearer <token>

Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.

In: header

Path Parameters

account*string

Public identifier (UUID v7) of your account. Get it from GET /v1/me (data.account.id).

Formatuuid

Query Parameters

contracted_seats*integer

Contracted seats to preview (absolute value, 0 or more).

Range0 <= value <= 1000

Headers

Factuarea-Version?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

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/accounts/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/additional-nif-seats/preview?contracted_seats=1", {  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": "additional_nif_seat_change_preview",
    "amount": "7.50",
    "tax_amount": "1.58",
    "total": "9.08",
    "product": "additional-nifs",
    "current_contracted": 2,
    "target_contracted": 3,
    "seats_to_buy": 1,
    "currency": "EUR",
    "recurring_quantity": 3,
    "recurring_total_cents": 908,
    "next_invoice_at": "2026-12-01T00:00:00+00:00",
    "pending_reduction": null,
    "deactivations_required": 0,
    "cancels_pending_reduction": false,
    "offer_package_loss": null,
    "charges_now": true,
    "requires_payment_method": false,
    "requires_active_plan": false,
    "included_in_trial": false,
    "applies_when": "now",
    "seats": {
      "contracted": 3,
      "occupied": 3,
      "free": 0,
      "agreed_minimum": 0,
      "agreed_minimum_ends_at": null,
      "reducible_to": 0,
      "pending_reduction": null,
      "enforced": true
    }
  }
}

Retired X-Active-Profile header sent

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_unknown",
    "subcode": "retired_active_profile_header",
    "message": "La cabecera 'X-Active-Profile' fue retirada de la API v1: la empresa efectiva se indica en el segmento de empresa de la ruta.",
    "param": "X-Active-Profile",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_unknown",
    "request_id": "req_01J8Y3M2Q40000000000000001"
  }
}

Malformed Factuarea-Version header

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid_format",
    "message": "El header 'Factuarea-Version' debe tener formato YYYY-MM-DD.",
    "param": "Factuarea-Version",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid_format",
    "request_id": "req_01J8Y3M2Q40000000000000002"
  }
}

Unsupported Factuarea-Version

{
  "error": {
    "type": "invalid_request_error",
    "code": "unsupported_api_version",
    "message": "La versión de API '2020-01-01' no está soportada.",
    "param": "Factuarea-Version",
    "doc_url": "https://docs.factuarea.com/guides/errors#unsupported_api_version",
    "request_id": "req_01J8Y3M2Q40000000000000003"
  }
}

{
  "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_61a5c0d17e2b94f3a8d05c1e72"
  }
}

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

Resource not found

{
  "error": {
    "type": "not_found_error",
    "code": "resource_not_found",
    "message": "El recurso solicitado no existe o pertenece a otra empresa.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#resource_not_found",
    "request_id": "req_01HKQS5NEQ6X1R4N9B0C5DWTPG"
  }
}

Account not found or not the account of the API key

{
  "error": {
    "type": "not_found_error",
    "code": "account_not_found",
    "message": "La cuenta indicada no existe o no es la de tu credencial.",
    "param": "account",
    "doc_url": "https://docs.factuarea.com/guides/errors#account_not_found",
    "request_id": "req_01J8Y3M2Q40000000000000006"
  }
}

{
  "error": {
    "type": "conflict_error",
    "code": "customer_offer_phase_incompatible",
    "subcode": "customer_offer_phase_incompatible",
    "message": "Las condiciones adquiridas del asiento requieren revisión antes de añadir empresas gestionadas.",
    "param": "quantity",
    "details": {
      "reason": "phase_incompatible"
    },
    "doc_url": "https://docs.factuarea.com/guides/errors#customer_offer_phase_incompatible",
    "request_id": "req_4b9e17c3a52d80f6e1a7c39d05"
  }
}

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

{
  "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_8c3e52fa1d46b79e2e5f1c0b74"
  }
}

{
  "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_9d4f63ab2e57c8af3f602d1c85"
  }
}

{
  "error": {
    "type": "service_unavailable_error",
    "code": "gestoria_seat_preview_unavailable",
    "subcode": "gestoria_seat_preview_unavailable",
    "message": "No se puede calcular el cargo de la empresa gestionada. Revisa la configuración de facturación antes de continuar.",
    "doc_url": "https://docs.factuarea.com/guides/errors#gestoria_seat_preview_unavailable",
    "request_id": "req_c71d3a9e0b5f48a2d6e13b8f47"
  }
}

Preview a change of the additional tax ID seats

Authorization

Path Parameters

Query Parameters

Headers

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`