Periodo de Facturación

Devuelve el periodo de facturación activo del workspace autenticado, junto con el tipo de facturación, plan y créditos incluidos.

GET https://api.platica.mx/v1/usage/period

Parámetros de consulta

ParámetroTipoDescripciónRequerido
workspacestringFiltra la respuesta a un workspace específico. Si se omite, devuelve todos los workspaces accesibles

Respuesta

{
  "workspaces": [
    {
      "id": "g6yCA16pkWl5eXo7KszB",
      "name": "Mi empresa",
      "usagePeriod": {
        "billingType": "subscription",
        "plan": {
          "name": "Growth",
          "credits": 6500
        },
        "billingPeriod": {
          "startDate": "2026-06-01T00:00:00.000Z",
          "endDate": "2026-06-30T23:59:59.999Z"
        },
        "resetDate": "2026-06-30T23:59:59.999Z",
        "dataSince": "2026-05-21T06:00:00.000Z"
      }
    }
  ],
  "workspacesCount": 1
}

Campos de la respuesta

CampoDescripción
idID del workspace
nameNombre del workspace
usagePeriod.billingTypeTipo de facturación: trial, free, subscription o enterprise
usagePeriod.plan.nameNombre del plan. En workspaces enterprise es enterprise
usagePeriod.plan.creditsCréditos incluidos configurados para el workspace
usagePeriod.billingPeriodVentana activa para medir consumo (startDate y endDate)
usagePeriod.resetDateFecha en la que termina el periodo actual
usagePeriod.dataSincePrimera fecha confiable para métricas billable
workspacesCountTotal de workspaces devueltos