GET /marketplace_listing/plans/{plan_id}/accounts

Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

Servers

Path parameters

Name Type Required Description
plan_id Integer Yes

The unique identifier of the plan.

Query parameters

Name Type Required Description
page Integer No

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Default value: 1

direction String No

To return the oldest accounts first, set to asc. Ignored without the sort parameter.

Possible values:

  • "desc"
  • "asc"
sort String No

The property to sort the results by.

Possible values:

  • "updated"
  • "created"

Default value: "created"

per_page Integer No

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Default value: 30

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.