marketplace_listings

Creates, updates, deletes, gets or lists a marketplace_listings resource.

Overview

Name	marketplace_listings
Type	Resource
Id	github.apps.marketplace_listings

Fields

The following fields are returned by SELECT queries:

list_plans

Response

Name	Datatype	Description
id	integer
name	string	(example: Pro)
unit_name	string
accounts_url	string (uri)	(example: https://api.github.com/marketplace_listing/plans/1313/accounts)
bullets	array
description	string	(example: A professional-grade CI solution)
has_free_trial	boolean
monthly_price_in_cents	integer
number	integer
price_model	string	(FREE, FLAT_RATE, PER_UNIT) (example: FLAT_RATE)
state	string	(example: published)
url	string (uri)	(example: https://api.github.com/marketplace_listing/plans/1313)
yearly_price_in_cents	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_plans	select		per_page, page	Lists all plans that are part of your GitHub Marketplace listing. 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

list_plans

Lists all plans that are part of your GitHub Marketplace listing.

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.

SELECT
id,
name,
unit_name,
accounts_url,
bullets,
description,
has_free_trial,
monthly_price_in_cents,
number,
price_model,
state,
url,
yearly_price_in_cents
FROM github.apps.marketplace_listings
WHERE per_page = '{{ per_page }}'
AND page = '{{ page }}'
;