Request

object

Properties

Key Required Type Description Example Default
id

Required

string Unique request identifier
success

Required

boolean Did the request execute successfully?
true
period_start

Required

string The start date and time of the current subscription API plan
next_period_start

Required

string The start date and time of the next subscription API plan. Usually a calendar month after the period_start
requests_this_period

Optional

integer (int64) The number of successfully executed API calls (requests) this period so far
0
credit_available_this_period

Required

integer (int64) The total number of Data Credits available for use in this period. This is based upon the subscribed API Plan
0
credit_used_this_request

Required

integer (int64) The number of Data Credits used to process the current API request
1
credit_used_this_period

Required

integer (int64) The total number of Data Credits already used from period_start
0
credit_remaining_this_period

Required

string The total number of Data Credits still available this period
account_id

Optional

string The internal to.co Account ID related to the API Plan
subscription_id

Optional

string The internal to.co Subscription ID related to the API Plan

Example

{
  "id": "caedc1bd-a4d4-4e18-a904-bac04c31fe85",
  "success": true,
  "period_start": "2025-02-03T14:49:40.000Z",
  "next_period_start": "2025-03-03T14:49:40.000Z",
  "requests_this_period": 2000,
  "credit_available_this_period": 10000,
  "credit_used_this_request": 1,
  "credit_used_this_period": 2500,
  "credit_remaining_this_period": 7500,
  "account_id": "fddb84zz.acct.to.co",
  "subscription_id": "Az9g3fSwOBwtj2El"
}