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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/marketplace_listing/accounts/'

Response Example

200 - Example 1

{
    "email": "string",
    "id": 0,
    "login": "string",
    "marketplace_pending_change": {
        "effective_date": "string",
        "id": 0,
        "is_installed": true,
        "plan": {
            "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts",
            "bullets": [
                "Up to 25 private repositories",
                "11 concurrent builds"
            ],
            "description": "A professional-grade CI solution",
            "has_free_trial": true,
            "id": 1313,
            "monthly_price_in_cents": 1099,
            "name": "Pro",
            "number": 3,
            "price_model": "FLAT_RATE",
            "state": "published",
            "unit_name": "string",
            "url": "https://api.github.com/marketplace_listing/plans/1313",
            "yearly_price_in_cents": 11870
        },
        "unit_count": 0
    },
    "marketplace_purchase": {
        "billing_cycle": "string",
        "free_trial_ends_on": "string",
        "is_installed": true,
        "next_billing_date": "string",
        "on_free_trial": true,
        "plan": {
            "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts",
            "bullets": [
                "Up to 25 private repositories",
                "11 concurrent builds"
            ],
            "description": "A professional-grade CI solution",
            "has_free_trial": true,
            "id": 1313,
            "monthly_price_in_cents": 1099,
            "name": "Pro",
            "number": 3,
            "price_model": "FLAT_RATE",
            "state": "published",
            "unit_name": "string",
            "url": "https://api.github.com/marketplace_listing/plans/1313",
            "yearly_price_in_cents": 11870
        },
        "unit_count": 0,
        "updated_at": "string"
    },
    "organization_billing_email": "string",
    "type": "string",
    "url": "string"
}

Request

Path Params

account_id

integer

required

account_id parameter

Responses

🟢200Response

application/json

Body

Marketplace Purchase

string | null

optional

integer

required

string

required

marketplace_pending_change

object | null

optional

effective_date

string

optional

integer

optional

is_installed

boolean

optional

plan

object (Marketplace Listing Plan)

optional

Marketplace Listing Plan

unit_count

integer | null

optional

marketplace_purchase

object

required

billing_cycle

string

optional

free_trial_ends_on

string | null

optional

is_installed

boolean

optional

next_billing_date

string | null

optional

on_free_trial

boolean

optional

plan

object (Marketplace Listing Plan)

optional

Marketplace Listing Plan

unit_count

integer | null

optional

updated_at

string

optional

organization_billing_email

string

optional

type

string

required

url

string

required

🟠401401

🟠404Not Found when the account has not purchased the listing

Modified at 2023-08-15 02:59:27

Revoke an installation access token

List plans