Skip to content
forgit api docs

Get a subscription plan for an account

GET
/marketplace_listing/accounts/{account_id}

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. 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.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
account_id
required
integer

Account_id parameter

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Marketplace Purchase

Marketplace Purchase

object
url
required
string
type
required
string
id
required
integer
login
required
string
organization_billing_email
string
email
string
nullable
marketplace_pending_change
object
is_installed
boolean
effective_date
string
unit_count
integer
nullable
id
integer
plan
Marketplace Listing Plan

Marketplace Listing Plan

object
url
required
string format: uri
accounts_url
required
string format: uri
id
required
integer
number
required
integer
name
required
string
description
required
string
monthly_price_in_cents
required
integer
yearly_price_in_cents
required
integer
price_model
required
string
Allowed values: FREE FLAT_RATE PER_UNIT
has_free_trial
required
boolean
unit_name
required
string
nullable
state
required
string
bullets
required
Array<string>
marketplace_purchase
required
object
billing_cycle
string
next_billing_date
string
nullable
is_installed
boolean
unit_count
integer
nullable
on_free_trial
boolean
free_trial_ends_on
string
nullable
updated_at
string
plan
Marketplace Listing Plan

Marketplace Listing Plan

object
url
required
string format: uri
accounts_url
required
string format: uri
id
required
integer
number
required
integer
name
required
string
description
required
string
monthly_price_in_cents
required
integer
yearly_price_in_cents
required
integer
price_model
required
string
Allowed values: FREE FLAT_RATE PER_UNIT
has_free_trial
required
boolean
unit_name
required
string
nullable
state
required
string
bullets
required
Array<string>
Examples
Example default 
{
  "url": "https://api.github.com/orgs/github",
  "type": "Organization",
  "id": 4,
  "login": "github",
  "organization_billing_email": "billing@github.com",
  "email": "billing@github.com",
  "marketplace_pending_change": {
    "effective_date": "2017-11-11T00:00:00Z",
    "unit_count": null,
    "id": 77,
    "plan": {
      "url": "https://api.github.com/marketplace_listing/plans/1111",
      "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts",
      "id": 1111,
      "number": 2,
      "name": "Startup",
      "description": "A professional-grade CI solution",
      "monthly_price_in_cents": 699,
      "yearly_price_in_cents": 7870,
      "price_model": "FLAT_RATE",
      "has_free_trial": true,
      "state": "published",
      "unit_name": null,
      "bullets": [
        "Up to 10 private repositories",
        "3 concurrent builds"
      ]
    }
  },
  "marketplace_purchase": {
    "billing_cycle": "monthly",
    "next_billing_date": "2017-11-11T00:00:00Z",
    "unit_count": null,
    "on_free_trial": true,
    "free_trial_ends_on": "2017-11-11T00:00:00Z",
    "updated_at": "2017-11-02T01:12:12Z",
    "plan": {
      "url": "https://api.github.com/marketplace_listing/plans/1313",
      "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts",
      "id": 1313,
      "number": 3,
      "name": "Pro",
      "description": "A professional-grade CI solution",
      "monthly_price_in_cents": 1099,
      "yearly_price_in_cents": 11870,
      "price_model": "FLAT_RATE",
      "has_free_trial": true,
      "unit_name": null,
      "state": "published",
      "bullets": [
        "Up to 25 private repositories",
        "11 concurrent builds"
      ]
    }
  }
}

401

Section titled “ 401 ”

Requires authentication

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Section titled “ 404 ”

Not Found when the account has not purchased the listing

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}