Skip to main content
GET
/
external
/
customers
/
external-id
/
{externalId}
/
customPricingUnits
/
{customPricingUnitId}
/
usage
Get custom pricing unit usage
curl --request GET \
  --url https://platform.runonatlas.com/external/customers/external-id/{externalId}/customPricingUnits/{customPricingUnitId}/usage \
  --header 'x-api-key: <api-key>'
{
  "customPricingUnitId": "atlas-internal-custom-pricing-unit-id-123",
  "displayName": "API Calls",
  "displayNameSingular": "API Call",
  "shortName": "calls",
  "totalAllocated": 1000,
  "totalUsed": 100,
  "remaining": 900,
  "nextExpiring": {
    "amountRemaining": 100,
    "expiration": "2025-01-01T00:00:00.000Z"
  }
}

Authorizations

​
x-api-key
string
header
required

You can obtain this key from the Atlas dashboard. It must be of type secret

Path Parameters

​
externalId
string
required

The external ID of the customer (e.g. the customer ID in your system)

Minimum string length: 1
Example:

"external-customer-id-123"

​
customPricingUnitId
string
required

The ID of the custom pricing unit

Example:

"custom-pricing-unit-id-123"

Response

The custom pricing unit usage for the customer.

The usage and amount remaining for all custom pricing units this customer has access to for the current billing period

​
customPricingUnitId
string
required

The ID of the custom pricing unit

Example:

"atlas-internal-custom-pricing-unit-id-123"

​
displayName
string
required

The display name of the custom pricing unit

Example:

"API Calls"

​
displayNameSingular
string
required

The display name singular of the custom pricing unit

Example:

"API Call"

​
shortName
string | null
required

The short name of the custom pricing unit

Example:

"calls"

​
totalAllocated
number
required

The total allocated amount of the custom pricing unit

Example:

1000

​
totalUsed
number
required

The total used amount of the custom pricing unit

Example:

100

​
remaining
number
required

The remaining amount of the custom pricing unit

Example:

900

​
nextExpiring
object
required

The next expiring allocation block