VendorAccountUsage
What the api read of the vendor account behind a credential (1.40.0): its status, the units used and allowed in the current period, when the period ends and the plan's tier. A reading at read_at, not a live figure; a key that authenticates can still belong to an exhausted account.
An object with 7 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
limit | integer or null | yes | The units the account's plan allows in the current period; null when the vendor gives none or sets no limit. |
period_ends_at | Timestamp or null | yes | When the vendor resets the allowance, the end of the current period; null when the vendor gives none. |
read_at | Timestamp | yes | When the api read the vendor account. |
status | VendorAccountStatus | yes | |
tier | string or null | yes | The vendor's name for the account's plan, such as starter: 1 to 40 letters, digits, _, ., : or -; null when the vendor gives none. |
unit | VendorAccountUnit | yes | |
used | integer or null | yes | The units the account has used in the current period, as the vendor answered; null when the vendor gives none. |