Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Subscription status list in CLI docs is missing values

Open
#1,001 2 comments 0 reactions 1 assignee View on GitHub

@asonnenschein is already working on this.

Since Sep 5, 2024.

Assessment

This issue has not been assessed yet.

Description

bug documentation subscriptions api

https://planet-sdk-for-python-v2.readthedocs.io/en/latest/cli/cli-subscriptions/#subscription-results

{code}
The available statuses are created, queued, processing, failed, and success. Note it's quite useful to use jq to help filter out results as well.
{code}

But ...

{code}
planet subscriptions list --status asdf
Usage: planet subscriptions list [OPTIONS]
Try 'planet subscriptions list --help' for help.

Error: Invalid value for '--status': 'asdf' is not one of 'running', 'cancelled', 'preparing', 'pending', 'completed', 'suspended', 'failed'.
{code}

The error message lists the correct statuses, but the docs do not.

https://developers.planet.com/docs/subscriptions/#subscription-status

Dominant language
Python
Stars
299
Forks
100
Avg merge
7d 8h
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from planetlabs/planet-client-python

All issues in planetlabs/planet-client-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.