Back to GithubList accounts for a plan
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.
Input
type: object
properties:
parameters:
type: object
properties:
plan_id:
type: integer
description: The unique identifier of the plan.
sort:
type: string
enum:
- created
- updated
default: created
description: The property to sort the results by.
direction:
type: string
enum:
- asc
- desc
description: >-
To return the oldest accounts first, set to `asc`. Ignored without the
`sort` parameter.
per_page:
type: integer
default: 30
description: The number of results per page (max 100).
page:
type: integer
default: 1
description: Page number of the results to fetch.
required:
- plan_id
title: Parameters
Output
type: array
items:
type: object
title: Marketplace Purchase
properties:
url:
type: string
type:
type: string
id:
type: integer
login:
type: string
organization_billing_email:
type: string
email:
type: string
nullable: true
marketplace_pending_change:
type: object
properties:
is_installed:
type: boolean
effective_date:
type: string
unit_count:
type: integer
nullable: true
id:
type: integer
plan:
type: object
title: Marketplace Listing Plan
properties:
url:
type: string
format: uri
example: https://api.github.com/marketplace_listing/plans/1313
accounts_url:
type: string
format: uri
example: https://api.github.com/marketplace_listing/plans/1313/accounts
id:
type: integer
example: 1313
number:
type: integer
example: 3
name:
type: string
example: Pro
description:
type: string
example: A professional-grade CI solution
monthly_price_in_cents:
type: integer
example: 1099
yearly_price_in_cents:
type: integer
example: 11870
price_model:
type: string
enum:
- FREE
- FLAT_RATE
- PER_UNIT
example: FLAT_RATE
has_free_trial:
type: boolean
example: true
unit_name:
type: string
nullable: true
state:
type: string
example: published
bullets:
type: array
items:
type: string
marketplace_purchase:
type: object
properties:
billing_cycle:
type: string
next_billing_date:
type: string
nullable: true
is_installed:
type: boolean
unit_count:
type: integer
nullable: true
on_free_trial:
type: boolean
free_trial_ends_on:
type: string
nullable: true
updated_at:
type: string
plan:
type: object
title: Marketplace Listing Plan
properties:
url:
type: string
format: uri
example: https://api.github.com/marketplace_listing/plans/1313
accounts_url:
type: string
format: uri
example: https://api.github.com/marketplace_listing/plans/1313/accounts
id:
type: integer
example: 1313
number:
type: integer
example: 3
name:
type: string
example: Pro
description:
type: string
example: A professional-grade CI solution
monthly_price_in_cents:
type: integer
example: 1099
yearly_price_in_cents:
type: integer
example: 11870
price_model:
type: string
enum:
- FREE
- FLAT_RATE
- PER_UNIT
example: FLAT_RATE
has_free_trial:
type: boolean
example: true
unit_name:
type: string
nullable: true
state:
type: string
example: published
bullets:
type: array
items:
type: string