sponsorships

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

Overview

Name	sponsorships
Type	Resource
Id	github.users.sponsorships

Fields

The following fields are returned by SELECT queries:

list

Response

Name	Datatype	Description
id	string	The GraphQL node ID of the sponsorship.
created_at	string (date-time)
is_active	boolean
is_one_time_payment	boolean
privacy_level	string	PUBLIC or PRIVATE.
sponsor_entity	object	The sponsoring user or organization (login, name).
tier	object	The sponsorship tier (name, monthly_price_in_dollars, monthly_price_in_cents, is_one_time).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	username		GitHub Sponsors sponsorships where the user is the maintainer being sponsored. Backed by the GitHub GraphQL API (user.sponsorshipsAsMaintainer). Private sponsorships are only visible to the sponsored account.

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
username	string	The handle for the GitHub user account.

SELECT examples

list

GitHub Sponsors sponsorships where the user is the maintainer being sponsored. Backed by the GitHub GraphQL API (user.sponsorshipsAsMaintainer). Private sponsorships are only visible to the sponsored account.

SELECT
id,
created_at,
is_active,
is_one_time_payment,
privacy_level,
sponsor_entity,
tier
FROM github.users.sponsorships
WHERE username = '{{ username }}' -- required
;