Employees

Cancel the employee seat add-on

Cancel the per-employee billing add-on at period end; the plan subscription is untouched.

  • Returns the billing status; subscribed stays true until the period ends.
  • Owner or admin only (403 forbidden_action); 403 billing_managed_by_provider if the provider manages billing.
post/accounts/{account}/employee-seats/cancel

Request

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

Path parameters

accountstring uuid required

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

Headers

Idempotency-Keystring required
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide. Required on this operation: repeating it delivers an effect that cannot be taken back (an email sent, a file generated, a third-party call, a charge), so a request without this header is rejected with 422 idempotency_key_required before any business logic runs.

Factuarea-Versionstring date
Example:2026-06-01

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

Example response

{
  "data": {
    "object": "employee_seat_billing_status",
    "subscribed": true,
    "quantity": 4,
    "active_employees": 4,
    "unit_amount": "1.50",
    "tax_rate": 21,
    "tax_amount": "0.32",
    "total_per_seat": "1.82",
    "recurring_total": "7.28",
    "currency": "EUR",
    "billing_interval": "month",
    "next_invoice_at": "2026-08-01T09:12:00+00:00",
    "seats_billable": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.