Checking your quota and credit balance via the Planet API

You can check your remaining allocation through the Planet API. The same endpoint serves both pricing models; which values it returns depends on your plan.

Endpoint

GET https://api.planet.com/auth/v1/experimental/public/my/subscriptions

Note that this endpoint is experimental and may change.

Authentication method

Use Basic Auth. Your API key is the username, and the password field can be left blank.

Username: Your_API_Key
Password: [Leave Blank]

Understanding the response

On successful authentication, the API responds with details of all subscriptions linked to your account, including your remaining allocation.

Which applies to you

Your plan is shown in your Planet account. Plans on the current packages report usage in monitoring credits. Plans bought before the change report usage as download quota in square kilometres.

If your plan uses monitoring credits

The response reports your monitoring credit allocation and how much of it has been consumed, in place of the square kilometre quota values.

If your plan uses download quota (sq km)

Applies to plans bought before Planet moved to monitoring credits.

Key parameters

- quota_sqkm: the total quota available, in square kilometres.
- quota_used: the amount of quota already used.

Calculating remaining quota

Subtract quota_used from quota_sqkm:

Remaining Quota = quota_sqkm - quota_used
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.