Récupère une ressource Capacity.

GET

/capacity

const url = 'https://api.facteur.local/capacity';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.facteur.local/capacity \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
org:read

Responses

200

Ressource Capacity

application/json

Ce que l’organisation détient dans sa période de facturation ouverte, où c’est parti, et ce qu’elle peut encore dépenser.

object

capacity

Les opérations de la période : ce que donnent le plan, les packs et les ajustements, et ce qui a été dépensé. Un message reçu vaut une opération.

object

available

required

Les opérations qui restent dans la période. Null quand le volume est illimité.

integer | null

overage

required

Les messages reçus au-delà de ce que la période contient, facturés à l’usage dans la limite du plafond de dépense.

integer

prepaid

required

Les opérations que la période contient, dépensées ou non : le volume du plan et les crédits valides. Null quand le volume est illimité.

integer | null

sources

required

Chaque crédit qui n’a pas expiré, celui qui échoit en premier d’abord. Le dépassement facturé à l’usage n’est jamais une source.

Array<object>

object

expiresOn

required

Le premier jour où le crédit ne compte plus (AAAA-MM-JJ, UTC).

string format: date

frozen

required

Vrai quand la fin de l’abonnement gèle le crédit : il compte de nouveau quand l’abonnement reprend.

boolean

operations

required

Les opérations que le crédit contient. Négatif pour un ajustement qui reprend des opérations.

integer

origin

required

Plan_grant : le volume du plan pour la période ouverte ; pack : un pack acheté ; adjustment : des opérations accordées ou reprises.

string

Allowed values: plan_grant pack adjustment

remaining

required

Les opérations restantes : operations moins used. Un crédit gelé les garde.

integer

used

required

Les opérations déjà prélevées sur le crédit.

integer

used

required

Les opérations de la période prélevées sur ce qu’elle contient.

integer

held

Vrai tant qu’aucun abonnement ne court, coupé pour impayé ou terminé : les packs sont gelés, pas perdus, et comptent de nouveau quand un abonnement reprend.

boolean

outcomes

Ce que sont devenus les messages de la période. Un message refusé dit pourquoi : un trou dans un parcours s’explique.

object

received

required

Les messages reçus et gardés, dépassement compris. Chacun vaut une opération.

integer

refusedCapacity

required

Refusés parce que la période n’avait plus d’opérations et que le plan ne facture aucun dépassement (PLAN_QUOTA_EXCEEDED).

integer

refusedDailyWindow

required

Refusés par la limite quotidienne du dépassement, qui empêche une seule journée de consommer tout le plafond ; elle se lève le lendemain (DAILY_SPIKE_CAP).

integer

refusedInboxCeiling

required

Refusés par un plafond posé sur une inbox ou sur un espace (INBOX_QUOTA_EXCEEDED, WORKSPACE_QUOTA_EXCEEDED).

integer

refusedOverageCap

required

Refusés au plafond de dépense (OVERAGE_CAP_REACHED).

integer

refusedSuspended

required

Refusés parce que le compte est coupé pour un abonnement impayé (SUBSCRIPTION_SUSPENDED).

integer

payments

Ce qui s’achète pour détenir davantage. Un pack s’achète dans l’application Facteur, jamais avec une clé.

object

packs

required

Les packs d’opérations en vente, le plus petit d’abord.

Array<object>

object

priceMinor

required

En centimes hors taxes : le prix du pack.

integer

size

required

Les opérations que le pack donne.

integer

period

La période de facturation ouverte. Elle va d’un anniversaire de l’abonnement au suivant : ce n’est pas le mois civil, sauf pour un compte ouvert le premier du mois.

object

dayOfPeriod

required

Le jour de la période où l’on est aujourd’hui, 1 le premier jour.

integer

endsOn

required

Le jour où la période suivante s’ouvre et où le volume du plan repart (AAAA-MM-JJ, UTC).

string format: date

key

required

Le premier jour de la période, qui lui donne son nom (AAAA-MM-JJ, UTC).

string format: date

lengthDays

required

Le nombre de jours de la période.

integer

projection

Quand les opérations de la période seront épuisées au rythme actuel : le chiffre que lisent à la fois l’écran de consommation et l’alerte.

object

exhaustsOn

required

Le jour (AAAA-MM-JJ, UTC) où la capacité s’épuise au rythme actuel, ou null quand il n’y a rien d’honnête à dire : moins de trois jours observés, rien de consommé, aucune capacité, une capacité déjà épuisée, ou une date au-delà de la période.

string | null format: date

headroomDays

required

Les jours de la période qui restent une fois la capacité épuisée, ou null sans projection.

integer | null

perDay

required

Les opérations utilisées par jour observé jusqu’ici, ou null sous trois jours observés ou quand rien n’a été utilisé.

integer | null

spendCap

Ce que l’organisation accepte de se voir facturer au-delà de ce que la période contient, en centimes hors taxes. Null sur un plan sans facturation à l’usage, où un message au-delà de la capacité est refusé.

object

bridled

required

Vrai jusqu’au premier paiement encaissé : le plafond le plus haut est alors celui par défaut.

boolean

ceilingMinor

required

Le plafond le plus haut qui peut être choisi.

integer

defaultMinor

required

Le plafond qui s’applique quand aucun n’a été choisi.

integer

setMinor

required

Le plafond choisi, ou null quand le plafond suit la capacité. Zéro n’est pas null : zéro refuse tout dépassement.

integer | null

Example

{
  "capacity": {
    "sources": [
      {
        "origin": "plan_grant"
      }
    ]
  }
}

401

Aucune clé, ou une clé refusée. WWW-Authenticate dit où lire comment en présenter une.

application/problem+json

Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.

object

code

required

Le code stable du refus. Il ne change jamais une fois publié.

string

Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND METHOD_NOT_ALLOWED NOT_ACCEPTABLE CONFLICT UNSUPPORTED_MEDIA_TYPE VALIDATION_FAILED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR INVALID_VALUE INVALID_CURSOR ORGANIZATION_LIMIT_REACHED ORGANIZATION_MEMBER_LIMIT_REACHED ORGANIZATION_FOUNDING_IN_PROGRESS ORGANIZATION_ALREADY_MEMBER ORGANIZATION_NAME_EMPTY ORGANIZATION_RENAME_LOCKED ORGANIZATION_RENAME_NOT_LOCKED ORGANIZATION_HAS_PAID_SUBSCRIPTION ORGANIZATION_LAST_OWNER ACCOUNT_DELETION_NOT_CONFIRMED ACCOUNT_HAS_OWN_ORGANIZATIONS ACCOUNT_IS_SOLE_OWNER LOGO_REFUSED LOGO_TOO_LARGE SSO_UNAVAILABLE SSO_PROVIDER_EXISTS SSO_PROVIDER_NOT_FOUND SSO_PROVIDER_REFUSED SSO_SAML_METADATA_INVALID SSO_SAML_METADATA_TOO_LARGE SSO_SAML_CERTIFICATE_EXPIRED SSO_SAML_CERTIFICATE_NOT_YET_VALID SSO_SAML_SHA1_REFUSED SSO_DOMAIN_INVALID SSO_DOMAIN_TAKEN SSO_DOMAIN_NOT_FOUND SSO_DOMAIN_NOT_PROVEN SSO_RESCUE_OWNER_REQUIRED SSO_WITHDRAWAL_EXPIRY_IN_THE_PAST SSO_WITHDRAWAL_EXPIRY_TOO_FAR SSO_WITHDRAWAL_EXPIRY_INVALID SSO_WITHDRAWAL_DOMAIN_NOT_PROVED SSO_DOMAIN_NOT_WITHDRAWN INVITATION_ALREADY_PENDING INVITATION_EXPIRED INVITATION_ALREADY_USED INVITATION_REVOKED INVITATION_ADDRESS_MISMATCH JOIN_LINK_EXPIRED JOIN_LINK_ALREADY_USED JOIN_LINK_REVOKED EMAIL_NOT_SENT WORKSPACE_NOT_FOUND NAME_REQUIRED NAME_TOO_LONG NAME_NOT_SLUGGABLE INVALID_SLUG SLUG_TAKEN TAG_TOO_LONG COLOR_INVALID WORKSPACE_LIMIT_REACHED WORKSPACE_QUOTAS_UNAVAILABLE CANNOT_DELETE_DEFAULT WORKSPACE_OPEN_TO_ORGANIZATION USER_REQUIRED NOT_AN_ORGANIZATION_MEMBER MEMBER_NOT_FOUND QUOTA_INVALID QUOTA_EMPTY ON_EXCEED_UNKNOWN DAILY_IS_INBOX_ONLY LIMIT_NOT_A_WHOLE_NUMBER LIMIT_IS_ZERO PERCENTAGE_OUT_OF_RANGE PERCENTAGE_NEEDS_A_CEILING INBOX_NOT_FOUND DESCRIPTION_INVALID TAGS_INVALID CHANNEL_UNKNOWN NOTHING_TO_UPDATE PERCENTAGE_IS_MONTHLY_ONLY INBOX_LIMIT_REACHED INBOX_QUOTAS_UNAVAILABLE SMS_NUMBER_LIMIT WORKSPACE_NOT_EMPTY MESSAGE_NOT_FOUND CRITERIA_EMPTY CRITERIA_UNKNOWN CRITERIA_INVALID TOO_MANY_WAITS API_DRAINING EXTRACTOR_NOT_FOUND INVALID_KEY KEY_ALREADY_USED PATTERN_REQUIRED INVALID_PATTERN INVALID_SCOPE INVALID_LABEL ATTACHMENT_NOT_FOUND ATTACHMENT_NOT_STORED ATTACHMENT_STORE_UNAVAILABLE SPEND_CAP_NEGATIVE SPEND_CAP_ABOVE_CEILING SPEND_CAP_MISSING SPEND_CAP_UNCHANGED PLAN_IS_UNLIMITED SUBSCRIPTION_ENDED NO_PAY_AS_YOU_GO SUBSCRIPTION_SUSPENDED PAYMENT_EVENT_REFUSED PAYMENT_PROVIDER_UNAVAILABLE CARD_SETUP_NOT_COMPLETE CARD_SETUP_NOT_FOUND CARD_SETUP_WITHOUT_CARD UNKNOWN_PACK PACK_FROZEN_UNTIL_RESUMED PLAN_NOT_PURCHASABLE TERM_REQUIRED ALREADY_SUBSCRIBED NO_SUBSCRIPTION PLAN_UNCHANGED NO_SUBSCRIPTION_TO_CANCEL COMMITMENT_BALANCE_REFUSED NO_CANCELLATION_TO_WITHDRAW BILLING_NAME_REQUIRED ADDRESS_INCOMPLETE COUNTRY_INVALID INVALID_VAT_NUMBER DESTINATION_KIND_UNKNOWN DESTINATION_ADDRESS_INVALID DESTINATION_NAME_INVALID DESTINATION_LOCALE_INVALID TOO_MANY_DESTINATIONS THRESHOLD_INVALID DESTINATION_KIND_IMMUTABLE DESTINATION_TARGET_INVALID DESTINATION_KEY_INVALID DESTINATION_REGION_UNKNOWN DESTINATION_FIELD_NOT_ALLOWED ALERT_CHANNEL_REFUSED ALERT_CHANNEL_UNAVAILABLE WEBHOOK_PORTAL_NOT_READY WEBHOOK_PLATFORM_UNAVAILABLE SUPPORT_KIND_INVALID SUPPORT_SUBJECT_REQUIRED SUPPORT_MESSAGE_REQUIRED FEATURE_REQUEST_SKELETON_EMPTY SUPPORT_TOO_MANY_THREADS SUPPORT_THREAD_NOT_FOUND SUPPORT_THREAD_CLOSED SUPPORT_THREAD_ALREADY_IN_STATE SUPPORT_ATTACHMENT_IDS_INVALID SUPPORT_TOO_MANY_ATTACHMENTS SUPPORT_ATTACHMENT_TOO_LARGE SUPPORT_ATTACHMENT_UNSUPPORTED SUPPORT_ATTACHMENT_REFUSED SUPPORT_TOO_MANY_UPLOADS SUPPORT_STORAGE_FULL SUPPORT_ATTACHMENT_NOT_FOUND SUPPORT_FILTER_INVALID SUPPORT_OUTCOME_INVALID SUPPORT_OUTCOME_NOT_ALLOWED SUPPORT_OUTCOME_NOTE_INVALID SUPPORT_NOT_A_FEATURE_REQUEST STAFF_REASON_INVALID OVERRIDE_EXPIRY_IN_THE_PAST OVERRIDE_EXPIRY_TOO_FAR OVERRIDE_EXPIRY_INVALID STAFF_EXPIRY_INVALID STAFF_EXPIRY_IN_THE_PAST STAFF_EXPIRY_TOO_FAR CAPACITY_OPERATIONS_NOT_POSITIVE CAPACITY_OPERATIONS_TOO_LARGE CAPACITY_GIFT_NOT_FOUND CAPACITY_GIFT_EXPIRED CAPACITY_RETRACTION_TOO_LARGE SPEND_CAP_BOUND_NOT_RAISED SPEND_CAP_BOUND_TOO_HIGH UNKNOWN_CAPABILITY CAPABILITY_OVERRIDE_NOT_FOUND USER_HAS_ORGANIZATIONS USERS_SELECTION_INVALID ASSISTANCE_SESSION_NOT_FOUND ASSISTANCE_SESSION_CLOSED ASSISTANCE_CODE_INVALID ASSISTANCE_TARGET_INVALID SUPPORT_ACCESS_NOT_GIVEN ASSISTANCE_CONSENT_ALREADY_GIVEN ASSISTANCE_CONSENT_NOT_FOUND ASSISTANCE_WRITE_REQUEST_PENDING ASSISTANCE_WRITE_REQUEST_NOT_FOUND EMAIL_DOMAIN_INVALID EMAIL_DOMAIN_ALREADY_BLOCKED EMAIL_DOMAIN_NOT_BLOCKED ASSISTANCE_FORBIDDEN ASSISTANCE_CONSENT_REQUIRED SESSION_CONFINED SIGN_IN_METHOD_NOT_ALLOWED SSO_NEVER_USED SECOND_FACTOR_MISSING SSO_EMAIL_NOT_PROVEN CONSOLE_SSO_REFUSED SUPPORT_CITATIONS_INVALID SUPPORT_CITATION_UNKNOWN AGENT_TOO_MANY_WRITES SUPPORT_ALREADY_REVIEWED SUPPORT_NOTHING_TO_REVIEW AGENT_TOKEN_NOT_FOUND AGENT_TOKEN_REVOKED AGENT_TOKEN_NAME_INVALID AGENT_TOKEN_NAME_TAKEN AGENT_TOKEN_SCOPES_INVALID API_KEY_NOT_FOUND API_KEY_NAME_INVALID API_KEY_PERMISSIONS_INVALID API_KEY_WORKSPACES_INVALID API_KEY_REVOKED WORKSPACE_HAS_ACTIVE_KEYS API_KEY_UNKNOWN API_KEY_EXPIRED API_KEY_PERMISSION_MISSING API_KEY_CANNOT_DELETE_WORKSPACE SMS_COUNTRY_NOT_OPEN SMS_NOTE_TOO_LONG SMS_INBOX_HAS_NUMBER SMS_REQUEST_ALREADY_OPEN SMS_REQUEST_NOT_FOUND SMS_REQUEST_NOT_WITHDRAWABLE SMS_REQUEST_NUMBER_SERVED SMS_REQUEST_NOT_IN_EXPECTED_STATE SMS_REQUEST_INBOX_DELETED SMS_NUMBER_INVALID SMS_NUMBER_TAKEN SMS_NUMBER_NOT_FOUND SMS_EVENT_REFUSED SMS_GATEWAY_UNAVAILABLE

detail

required

Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.

string

status

required

Le statut HTTP.

integer

title

required

Le nom du statut HTTP.

string

type

required

L’adresse du problème : /errors/<code>.

string

violations

Sur un corps qui échoue à la validation, une entrée par champ.

Array<object>

object

code

required

string

message

required

string

propertyPath

required

string

key

additional properties

any

Example

{
  "code": "BAD_REQUEST",
  "status": 404,
  "title": "Not Found",
  "type": "/errors/INBOX_NOT_FOUND",
  "violations": [
    {
      "code": "BAD_REQUEST"
    }
  ]
}

403

La clé n’a pas la permission de l’opération, ou l’opération refuse toutes les clés.

application/problem+json

object

code

required

Le code stable du refus. Il ne change jamais une fois publié.

string

detail

required

Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.

string

status

required

Le statut HTTP.

integer

title

required

Le nom du statut HTTP.

string

type

required

L’adresse du problème : /errors/<code>.

string

violations

Sur un corps qui échoue à la validation, une entrée par champ.

Array<object>

object

code

required

string

message

required

string

propertyPath

required

string

key

additional properties

any

Example

{
  "code": "BAD_REQUEST",
  "status": 404,
  "title": "Not Found",
  "type": "/errors/INBOX_NOT_FOUND",
  "violations": [
    {
      "code": "BAD_REQUEST"
    }
  ]
}

429

Plus d’appels que la clé n’en peut faire en une minute. Retry-After dit quand réessayer.

application/problem+json

object

code

required

Le code stable du refus. Il ne change jamais une fois publié.

string

detail

required

Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.

string

status

required

Le statut HTTP.

integer

title

required

Le nom du statut HTTP.

string

type

required

L’adresse du problème : /errors/<code>.

string

violations

Sur un corps qui échoue à la validation, une entrée par champ.

Array<object>

object

code

required

string

message

required

string

propertyPath

required

string

key

additional properties

any

Example

{
  "code": "BAD_REQUEST",
  "status": 404,
  "title": "Not Found",
  "type": "/errors/INBOX_NOT_FOUND",
  "violations": [
    {
      "code": "BAD_REQUEST"
    }
  ]
}

default

Any refusal: an application/problem+json body whose code says which.

application/problem+json

object

code

required

Le code stable du refus. Il ne change jamais une fois publié.

string

detail

required

Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.

string

status

required

Le statut HTTP.

integer

title

required

Le nom du statut HTTP.

string

type

required

L’adresse du problème : /errors/<code>.

string

violations

Sur un corps qui échoue à la validation, une entrée par champ.

Array<object>

object

code

required

string

message

required

string

propertyPath

required

string

key

additional properties

any

Example

{
  "code": "BAD_REQUEST",
  "status": 404,
  "title": "Not Found",
  "type": "/errors/INBOX_NOT_FOUND",
  "violations": [
    {
      "code": "BAD_REQUEST"
    }
  ]
}