Create, Estimate, and View Quota Reservations

Creating an area quota reservation¶

Get my products¶

Area quota requests are completed within the context of a product. In order to create or estimate a quota reservation you must first retrieve a valid id from my/products, which displays the products currently available to your organization.

Example:

GET https://api.planet.com/account/v1/my/products

Example response:

  "results": [
    {
      "billable_id": "prn:usage-api:bucket:306cf963-334d-49b6-b2c8-346da95a2fbf",
      "created_at": "2024-04-15T10:57:40.251801",
      "id": 1234,
      "organization_id": 6789,
      "product": {
        "description": "A fusion of daily and near real time microwave and optical satellite imagery.  It estimates relative above-ground crop biomass regardless of cloud cover - 10m resolution",
        "name": "BMP_10M",
        "title": "Biomass Proxy 10m"
      },
      "quota_total": null,
      "quota_used": 0.0,
      "term_end_date": "2029-01-01T23:59:59.999999",
      "term_start_date": "2023-01-01T00:00:00",
      "unlimited_quota": false,
      "updated_at": "2024-04-15T10:57:40.251815"
    }
  ]

Estimating the cost of a quota reservation¶

To estimate a quota reservation you must first upload your Areas of Interest (AOIs) via Planet's Features API. Use the generated feature reference as your aoi_refs value.

Take the ID value fetched from Get my products above and use this as your product_id.

POST https://api.planet.com/account/v1/quota-reservations/estimate

{
    "aoi_refs": ["pl:features/my/migratory_budgerigar_areas-2zxYEZD/191522007976127-aBCDEf9"],
    "product_id": 1234
}

Making a reservation¶

Making a reservation is the same as estimating above. Retrieve one or more valid aoi_refs and product_id to complete a request like so:

Example:

POST https://api.planet.com/account/v1/quota-reservations/

{
    "aoi_refs": ["pl:features/my/migratory_budgerigar_areas-2zxYEZD/191522007976127-aBCDEf9"],
    "product_id": 1234
}

Get a list of quota reservations¶

To view the status of your created quota reservations, you can:

GET https://api.planet.com/account/v1/quota-reservations

Get a specific quota reservation¶

To view a specific quota reservation, you can:

GET https://api.planet.com/account/v1/quota-reservations/{id}

Bulk Requests¶

Making reservations¶

Follow the same instructions from above for making a reservation, but simply include as many aoi_refs as you need to reserve.

For the best performance, POSTing one payload containing all of your aoi_refs is recommended over chunking and making multiple requests.

Example:

POST https://api.planet.com/account/v1/quota-reservations/bulk-reserve

{
    "aoi_refs": [
        "pl:features/my/migratory_budgerigar_areas-2zxYEZD/191522007976127-zGoijt3", "pl:features/my/migratory_budgerigar_areas-2zxYEZD/191522007976127-aBCDEf9", "pl:features/my/migratory_budgerigar_areas-2zxYEZD/191522007976127-c098Sga", ...
    ],
    "product_id": 1234
}