Saltar al contenido

Cuenta

Resumen de la cuenta: plan, uso del periodo, límites y recuentos.

Resumen de la cuenta

GET/v1/account

Scope necesario: read o full. Una clave full incluye send y read.

Organización, plan y suscripción, consumo del periodo (usage, con el tope propio de la organización si lo hay), límites de envío, recuentos de recursos y la clave que hace la petición. Solo lectura; 60 consultas por minuto y clave (compartidas con /v1/stats).

Respuestas

  • 200
    CampoDescripción
    organizationobject · obligatorio
    organization.idstring · obligatorio
    organization.namestring · obligatorio
    organization.statusstring · obligatorioEstado de la organización.valores: pending_review | active | paused | closed
    organization.createdAtstring · obligatorio
    planobject | null · obligatorio
    plan.codestring · obligatorioej.: beta
    plan.namestring · obligatorioej.: Beta
    plan.includedEmailsnumber · obligatorioEmails incluidos en el periodo.
    subscriptionobject | null · obligatorio
    subscription.statusstring · obligatorioej.: active
    subscription.periodStartstring · obligatorio
    subscription.periodEndstring · obligatorio
    periodobject · obligatorio
    period.startstring · obligatorio
    period.endstring · obligatorio
    period.basisstring · obligatoriosubscription: periodo de la suscripción; calendar_utc: mes natural UTC (sin suscripción vigente).valores: subscription | calendar_utc
    usageobject · obligatorio
    usage.sentnumber · obligatorioEmails live enviados en el periodo.
    usage.includednumber | null · obligatorio
    usage.remainingnumber | null · obligatorio
    usage.reservednumber · obligatorioEmails admitidos que aún no se han enviado.
    usage.capnumber | null · obligatorioTope del periodo: el menor entre el del plan (con la política de excedente) y el tope mensual propio de la organización si existe.
    usage.overagePolicystring · obligatoriovalores: hard_cap | overage
    limitsobject · obligatorio
    limits.perSecondnumber | null · obligatorio
    limits.dailynumber | null · obligatorio
    limits.monthlynumber | null · obligatorioTope mensual propio (null si no hay).
    countsobject · obligatorio
    counts.domainsnumber · obligatorio
    counts.verifiedDomainsnumber · obligatorio
    counts.contactsnumber · obligatorio
    counts.listsnumber · obligatorio
    counts.segmentsnumber · obligatorio
    counts.campaignsnumber · obligatorio
    counts.templatesnumber · obligatorioPlantillas con una versión publicada.
    counts.webhooksnumber · obligatorioWebhooks del entorno de la clave.
    apiKeyobject · obligatorio
    apiKey.idstring · obligatorio
    apiKey.namestring · obligatorio
    apiKey.prefixstring · obligatorioej.: vm_live_ab12cd34
    apiKey.environmentstring · obligatoriovalores: test | live
    apiKey.scopesstring[] · obligatorioej.: ["read"]
  • 429
    Límite de consultas superado.

Ejemplo

bash
curl https://api.vemudo.com/v1/account -H "Authorization: Bearer $VEMUDO_API_KEY"