Contract tracking

Pl@ntNet API provides a set of routes to track the status of your contract and your usage history.

Routes list

  • /v2/subscription
    • Returns your contract details, current status, signatures history, billing estimation and security settings.
  • /v2/quota/daily
    • Returns the request count by request type, for the current day.
  • /v2/quota/history
    • Returns the request count by request type, for each day since the start of your contract.

See OpenAPI doc for details.

cURL examples

GET /v2/subscription

curl 'https://my-api.plantnet.org/v2/subscription?api-key=YOUR_API_KEY'
{
  "account": {
    "id": "00000000000",
    "username": "test_fake_contract",
    "name": {
      "first": "Fake",
      "last": "Contract"
    },
    "created": "Fri, 03 Jun 2022 13:32:13 GMT"
  },
  "contract": {
    "plan": "pro",
    "status": "expired",
    "firstSignatureDate": "Fri, 03 Jun 2022 00:00:00 GMT",
    "latestSignatureDate": "Fri, 03 Jun 2022 00:00:00 GMT",
    "nextSignatureDate": "Sat, 03 Jun 2023 00:00:00 GMT",
    "indicativeYearlyQuota": 200000
  },
  "history": [
    {
      "period": "2022",
      "startDate": "Fri, 03 Jun 2022 00:00:00 GMT",
      "endDate": null,
      "count": {
        "identify": 10
      },
      "aboveQuota": {
        "identify": 7
      }
    }
  ],
  "billing": {
    "nextDueDate": "Sat, 03 Jun 2023 00:00:00 GMT",
    "estimatedAmount": 0
  },
  "security": {
    "exposeKey": false,
    "ips": [],
    "domains": []
  }
}

GET /v2/quota/daily

See quota.

GET /v2/quota/history

curl 'https://my-api.plantnet.org/v2/quota/history?api-key=YOUR_API_KEY'
[
  {
    "day": "2025-02-11",
    "quota": {
      "identify": {
        "count": 3966
      }
    }
  },
  {
    "day": "2025-02-10",
    "quota": {
      "identify": {
        "count": 6700
      }
    }
  },
  {
    "day": "2025-02-09",
    "quota": {
      "identify": {
        "count": 8625
      }
    }
  },
  {
    "day": "2025-02-08",
    "quota": {
      "identify": {
        "count": 6621
      }
    }
  },
  (…)
]