Fetchply Docs
API reference

Get account usage

GET
/api/v1/usage

Plan, message credits used against the monthly allowance, remaining add-on message balance, subscription status, and days until the period resets. Requires the read:usage permission.

Authorization

BearerAuth read:usage
AuthorizationBearer <token>

In: header

Scope: read:usage

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/usage"
{
  "plan": {
    "id": "pro",
    "name": "Pro"
  },
  "usage": {
    "messagesUsed": 1240,
    "messagesLimit": 15000,
    "percentUsed": 8,
    "addonMessagesRemaining": 3000,
    "totalMessagesRemaining": 16760
  },
  "subscription": {
    "status": "active",
    "billingInterval": "monthly",
    "currentPeriodEnd": "2026-08-28T00:00:00.000Z",
    "cancelAtPeriodEnd": false
  },
  "daysUntilReset": 24
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

Get a cash-on-delivery confirmation GET

Read one cash-on-delivery confirmation: its order reference, state, decision time, and any requested change. Buyer phone numbers are never returned. Requires the `read:cod` permission.

Attributions

Credits and licence details for the artwork used in Fetchply, including the chat launcher icons you can choose on the Widget Appearance page.