Usage

Read exact customer usage and charge aggregates

GET

https://api.signals.pressone.africa/v1

/usage/summary

Read exact customer usage and charge aggregates › query Parameters

range

string · enum

Enum values:

30d

mtd

last_month

custom

dimension

string · enum

Enum values:

day

product

trunk

subaccount

destination

number_block

Read exact customer usage and charge aggregates › Headers

X-Project-ID

string

The project the request acts on, as prj_ and its lowercase UUID; optional while the organization has one active project.

Read exact customer usage and charge aggregates › Responses

Usage totals, days and rows for the window.

UsageSummary

as_of

string · date-time · required

UsageProductAmount[] · required

currency

string · required

UsageDay[] · required

dimension

UsageDimension · enum · required

Enum values:

day

product

trunk

subaccount

destination

number_block

category

sku

required

UsageQuantity · required

row_count

integer · int64 · min: 0 · required

UsageRow[] · required

UsageScopes · required

UsageAmounts · required

UsageWindow · required

GET/usage/summary

curl https://api.signals.pressone.africa/v1/usage/summary \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "as_of": "2024-08-25T15:00:00Z",
  "by_product": [
    {
      "amount_minor": 0,
      "product": "trunking"
    }
  ],
  "currency": "currency",
  "days": [
    {
      "by_product": [
        {
          "amount_minor": 0,
          "product": "trunking"
        }
      ],
      "date": "2024-08-25",
      "partial": true,
      "total_minor": 0
    }
  ],
  "dimension": "day",
  "previous_totals": {
    "calls_minor": 0,
    "numbers_minor": 0,
    "promotional_credit_minor": 0,
    "recording_minor": 0,
    "settling_minor": 0,
    "total_minor": 0,
    "voice_minor": 0
  },
  "previous_window": {
    "days": 0,
    "from": "2024-08-25",
    "partial": true,
    "to": "2024-08-25"
  },
  "promotional_credit": {
    "applied_minor": 0,
    "expires_at": "2024-08-25T15:00:00Z",
    "remaining_minor": 0
  },
  "quantity": {
    "billable_seconds": 0,
    "calls": 0,
    "numbers": 0,
    "observed_seconds": 0,
    "recorded_seconds": 0
  },
  "row_count": 0,
  "rows": [
    {
      "amounts": {
        "calls_minor": 0,
        "numbers_minor": 0,
        "promotional_credit_minor": 0,
        "recording_minor": 0,
        "settling_minor": 0,
        "total_minor": 0,
        "voice_minor": 0
      },
      "detail": "detail",
      "dimension": "day",
      "key": "key",
      "label": "label",
      "parent_key": "parent_key",
      "quantity": {
        "billable_seconds": 0,
        "calls": 0,
        "numbers": 0,
        "observed_seconds": 0,
        "recorded_seconds": 0
      },
      "rate": {
        "atoms_per_unit": 0,
        "connection_fee_minor": 0,
        "offer_id": "offer_id",
        "price_id": "00000000-0000-0000-0000-000000000000",
        "quantity_increment_atoms": 0,
        "quantity_minimum_atoms": 0,
        "sku_code": "sku_code",
        "unit": "unit",
        "unit_price_minor": 0
      },
      "state": {
        "text": "text",
        "tone": "tone"
      }
    }
  ],
  "scopes": {
    "subaccounts": [
      {
        "id": "id",
        "name": "name"
      }
    ],
    "trunks": [
      {
        "id": "id",
        "name": "name"
      }
    ]
  },
  "totals": {
    "calls_minor": 0,
    "numbers_minor": 0,
    "promotional_credit_minor": 0,
    "recording_minor": 0,
    "settling_minor": 0,
    "total_minor": 0,
    "voice_minor": 0
  },
  "window": {
    "days": 0,
    "from": "2024-08-25",
    "partial": true,
    "to": "2024-08-25"
  }
}

json

application/json

Rates