Get a subscription plan for an account (stubbed)

GET /marketplace_listing/stubbed/accounts/{account_id}

Copy endpoint

https://api.github.com

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.

Parameters

path Path Parameters

Name	Type
`account_id` required account_id parameter	number

Responses

200 application/json

Response

interface MarketplacePurchase {
url: string;
type: string;
id: number;
login: string;
organization_billing_email?: string;
email?: string | null;
marketplace_pending_change?: {
is_installed?: boolean;
effective_date?: string;
unit_count?: number | null;
id?: number;
plan?:

MarketplaceListingPlan

Marketplace Listing Plan

interface MarketplaceListingPlan {
url: string;
accounts_url: string;
id: number;
number: number;
name: string;
description: string;
monthly_price_in_cents: number;
yearly_price_in_cents: number;
price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
has_free_trial: boolean;
unit_name: string | null;
state: string;
bullets: string[];
}

;
} | null;
marketplace_purchase: {
billing_cycle?: string;
next_billing_date?: string | null;
is_installed?: boolean;
unit_count?: number | null;
on_free_trial?: boolean;
free_trial_ends_on?: string | null;
updated_at?: string;
plan?:

MarketplaceListingPlan

Marketplace Listing Plan

;
};
}

Client Errors

401 application/json

Requires authentication

interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}

404

Not Found when the account has not purchased the listing

unknown