List subscriptions for the authenticated user

GET

/user/marketplace_purchases

Lists the active subscriptions for the authenticated user. You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/user/marketplace_purchases'

Response Example

200 - Example 1

[
    {
        "account": {
            "email": "user@example.com",
            "id": 0,
            "login": "string",
            "node_id": "string",
            "organization_billing_email": "user@example.com",
            "type": "string",
            "url": "http://example.com"
        },
        "billing_cycle": "monthly",
        "free_trial_ends_on": "2017-11-11T00:00:00.000Z",
        "next_billing_date": "2017-11-11T00:00:00.000Z",
        "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": "2017-11-02T01:12:12.000Z"
    }
]

Request

Query Params

per_page

integer

optional

The number of results per page (max 100).

page

integer

optional

Page number of the results to fetch.

Responses

🟢200Response

application/json

Body

array of:

account

object (Marketplace Account)

required

string <email> | null

optional

integer

required

string

required

node_id

string

optional

organization_billing_email

string <email> | null

optional

type

string

required

url

string <uri>

required

billing_cycle

string

required

Example:

monthly

free_trial_ends_on

string <date-time> | null

required

Example:

2017-11-11T00:00:00.000Z

next_billing_date

string <date-time> | null

required

Example:

2017-11-11T00:00:00.000Z

on_free_trial

boolean

required

Example:

true

plan

object (Marketplace Listing Plan)

required

Marketplace Listing Plan

accounts_url

string <uri>

required

Example:

https://api.github.com/marketplace_listing/plans/1313/accounts

bullets

array[string]

required

Example:

["Up to 25 private repositories","11 concurrent builds"]

description

string

required

Example:

A professional-grade CI solution

has_free_trial

boolean

required

Example:

true

integer

required

Example:

1313

monthly_price_in_cents

integer

required

Example:

1099

name

string

required

Example:

Pro

number

integer

required

Example:

price_model

enum<string>

required

Allowed values:

FREEFLAT_RATEPER_UNIT

Example:

FLAT_RATE

state

string

required

Example:

published

unit_name

string | null

required

url

string <uri>

required

Example:

https://api.github.com/marketplace_listing/plans/1313

yearly_price_in_cents

integer

required

Example:

11870

unit_count

integer | null

required

updated_at

string <date-time> | null

required

Example:

2017-11-02T01:12:12.000Z

🔵304304

🟠401401

🟠404404

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

Add a repository to an app installation

List subscriptions for the authenticated user (stubbed)