RelayAPI

Get subscription usage

Returns current plan details and API call usage statistics for the organization.

GET
/v1/usage
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_*)

In: header

Response Body

application/json

application/json

curl -X GET "https://api.relayapi.dev/v1/usage"
{
  "plan": {
    "name": "free",
    "api_calls_limit": 0,
    "api_calls_per_min": 0,
    "features": {
      "analytics": true,
      "inbox": true
    }
  },
  "subscription": {
    "status": "string",
    "monthly_price_cents": 0,
    "price_per_thousand_calls_cents": 0
  },
  "usage": {
    "api_calls_used": 0,
    "api_calls_remaining": 0,
    "overage_calls": 0,
    "overage_cost_cents": 0,
    "cycle_start": "2019-08-24T14:15:22Z",
    "cycle_end": "2019-08-24T14:15:22Z"
  },
  "rate_limit": {
    "limit_per_minute": 0
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}

Found something wrong? Help us improve this page.

Submit an Issue
Requires a GitHub account.View repo