Retrieve employee seat billing status
Return the billing status of the per-employee add-on for your company: whether the employee-seats subscription is active, how many seats are billed (quantity), how many employees are active, and the recurring per-seat cost with VAT.
- Amounts are in the currency minor units (cents) and are
nullwhen the cost is not resolvable (not subscribed, no active plan, enterprise outside Stripe, sandbox) — never a misleading 0.seats_billabletells whether your plan MUST be paying per seat, independently ofsubscribed:subscribed: falsewithseats_billable: trueand active employees is a billing anomaly, whileseats_billable: falseis a legitimate no-charge state (enterprise by contract, trial or sandbox). - Employees never count towards the plan
usersseat limit.
In: header
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.
dateOperate 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.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json