Sponsors

Reference documentation for GraphQL schema types in the Sponsors category.

In this article

Queries

sponsorables

Query

Users and organizations who can be sponsored via GitHub Sponsors.

Type: SponsorableItemConnection!

Arguments for sponsorables

NameDescription

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

dependencyEcosystem (SecurityAdvisoryEcosystem)

Optional filter for which dependencies should be checked for sponsorable owners. Only sponsorable owners of dependencies in this ecosystem will be included. Used when onlyDependencies = true.

Upcoming Change on 2022-07-01 UTC Description: dependencyEcosystem will be removed. Use the ecosystem argument instead. Reason: The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.

ecosystem (DependencyGraphEcosystem)

Optional filter for which dependencies should be checked for sponsorable owners. Only sponsorable owners of dependencies in this ecosystem will be included. Used when onlyDependencies = true.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

onlyDependencies (Boolean)

Whether only sponsorables who own the viewer's dependencies will be returned. Must be authenticated to use. Can check an organization instead for their dependencies owned by sponsorables by passing orgLoginForDependencies.

The default value is false.

orderBy (SponsorableOrder)

Ordering options for users and organizations returned from the connection.

orgLoginForDependencies (String)

Optional organization username for whose dependencies should be checked. Used when onlyDependencies = true. Omit to check your own dependencies. If you are not an administrator of the organization, only dependencies from its public repositories will be considered.

Mutations

cancelSponsorship

Mutation

Cancel an active sponsorship.

Input fields for cancelSponsorship

Return fields for cancelSponsorship

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorsTier (SponsorsTier)

The tier that was being used at the time of cancellation.

createSponsorship

Mutation

Start a new sponsorship of a maintainer in GitHub Sponsors, or reactivate a past sponsorship.

Input fields for createSponsorship

Return fields for createSponsorship

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorship (Sponsorship)

The sponsorship that was started.

createSponsorships

Mutation

Make many sponsorships for different sponsorable users or organizations at once. Can only sponsor those who have a public GitHub Sponsors profile.

Input fields for createSponsorships

Return fields for createSponsorships

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorables ([Sponsorable!])

The users and organizations who received a sponsorship.

createSponsorsListing

Mutation

Create a GitHub Sponsors profile to allow others to sponsor you or your organization.

Input fields for createSponsorsListing

Return fields for createSponsorsListing

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorsListing (SponsorsListing)

The new GitHub Sponsors profile.

createSponsorsTier

Mutation

Create a new payment tier for your GitHub Sponsors profile.

Input fields for createSponsorsTier

Return fields for createSponsorsTier

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorsTier (SponsorsTier)

The new tier.

publishSponsorsTier

Mutation

Publish an existing sponsorship tier that is currently still a draft to a GitHub Sponsors profile.

Input fields for publishSponsorsTier

Return fields for publishSponsorsTier

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorsTier (SponsorsTier)

The tier that was published.

retireSponsorsTier

Mutation

Retire a published payment tier from your GitHub Sponsors profile so it cannot be used to start new sponsorships.

Input fields for retireSponsorsTier

Return fields for retireSponsorsTier

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorsTier (SponsorsTier)

The tier that was retired.

updatePatreonSponsorability

Mutation

Toggle the setting for your GitHub Sponsors profile that allows other GitHub accounts to sponsor you on GitHub while paying for the sponsorship on Patreon. Only applicable when you have a GitHub Sponsors profile and have connected your GitHub account with Patreon.

Input fields for updatePatreonSponsorability

Return fields for updatePatreonSponsorability

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorsListing (SponsorsListing)

The GitHub Sponsors profile.

updateSponsorshipPreferences

Mutation

Change visibility of your sponsorship and opt in or out of email updates from the maintainer.

Input fields for updateSponsorshipPreferences

Return fields for updateSponsorshipPreferences

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

sponsorship (Sponsorship)

The sponsorship that was updated.

Objects

SponsorableItemConnection

Object

The connection type for SponsorableItem.

Fields for SponsorableItemConnection

NameDescription

edges ([SponsorableItemEdge])

A list of edges.

nodes ([SponsorableItem])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

SponsorableItemEdge

Object

An edge in a connection.

Fields for SponsorableItemEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (SponsorableItem)

The item at the end of the edge.

SponsorAndLifetimeValue

Object

A GitHub account and the total amount in USD they've paid for sponsorships to a particular maintainer. Does not include payments made via Patreon.

Fields for SponsorAndLifetimeValue

NameDescription

amountInCents (Int!)

The amount in cents.

formattedAmount (String!)

The amount in USD, formatted as a string.

sponsor (Sponsorable!)

The sponsor's GitHub account.

sponsorable (Sponsorable!)

The maintainer's GitHub account.

SponsorAndLifetimeValueConnection

Object

The connection type for SponsorAndLifetimeValue.

Fields for SponsorAndLifetimeValueConnection

NameDescription

edges ([SponsorAndLifetimeValueEdge])

A list of edges.

nodes ([SponsorAndLifetimeValue])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

SponsorAndLifetimeValueEdge

Object

An edge in a connection.

Fields for SponsorAndLifetimeValueEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (SponsorAndLifetimeValue)

The item at the end of the edge.

SponsorConnection

Object

A list of users and organizations sponsoring someone via GitHub Sponsors.

Fields for SponsorConnection

NameDescription

edges ([SponsorEdge])

A list of edges.

nodes ([Sponsor])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

SponsorEdge

Object

Represents a user or organization who is sponsoring someone in GitHub Sponsors.

Fields for SponsorEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Sponsor)

The item at the end of the edge.

SponsorsActivity

Object

An event related to sponsorship activity.

SponsorsActivity Implements

Fields for SponsorsActivity

NameDescription

action (SponsorsActivityAction!)

What action this activity indicates took place.

currentPrivacyLevel (SponsorshipPrivacy)

The sponsor's current privacy level.

id (ID!)

The Node ID of the SponsorsActivity object.

paymentSource (SponsorshipPaymentSource)

The platform that was used to pay for the sponsorship.

previousSponsorsTier (SponsorsTier)

The tier that the sponsorship used to use, for tier change events.

sponsor (Sponsor)

The user or organization who triggered this activity and was/is sponsoring the sponsorable.

sponsorable (Sponsorable!)

The user or organization that is being sponsored, the maintainer.

sponsorsTier (SponsorsTier)

The associated sponsorship tier.

timestamp (DateTime)

The timestamp of this event.

viaBulkSponsorship (Boolean!)

Was this sponsorship made alongside other sponsorships at the same time from the same sponsor?.

SponsorsActivityConnection

Object

The connection type for SponsorsActivity.

Fields for SponsorsActivityConnection

NameDescription

edges ([SponsorsActivityEdge])

A list of edges.

nodes ([SponsorsActivity])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

SponsorsActivityEdge

Object

An edge in a connection.

Fields for SponsorsActivityEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (SponsorsActivity)

The item at the end of the edge.

SponsorsGoal

Object

A goal associated with a GitHub Sponsors listing, representing a target the sponsored maintainer would like to attain.

Fields for SponsorsGoal

NameDescription

description (String)

A description of the goal from the maintainer.

kind (SponsorsGoalKind!)

What the objective of this goal is.

percentComplete (Int!)

The percentage representing how complete this goal is, between 0-100.

targetValue (Int!)

What the goal amount is. Represents an amount in USD for monthly sponsorship amount goals. Represents a count of unique sponsors for total sponsors count goals.

title (String!)

A brief summary of the kind and target value of this goal.

Sponsorship

Object

A sponsorship relationship between a sponsor and a maintainer.

Sponsorship Implements

Fields for Sponsorship

NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the Sponsorship object.

isActive (Boolean!)

Whether the sponsorship is active. False implies the sponsor is a past sponsor of the maintainer, while true implies they are a current sponsor.

isOneTimePayment (Boolean!)

Whether this sponsorship represents a one-time payment versus a recurring sponsorship.

isSponsorOptedIntoEmail (Boolean)

Whether the sponsor has chosen to receive sponsorship update emails sent from the sponsorable. Only returns a non-null value when the viewer has permission to know this.

maintainer (User!)

The entity that is being sponsored.

Warning

maintainer is deprecated.

Sponsorship.maintainer will be removed. Use Sponsorship.sponsorable instead. Removal on 2020-04-01 UTC.

paymentSource (SponsorshipPaymentSource)

The platform that was most recently used to pay for the sponsorship.

privacyLevel (SponsorshipPrivacy!)

The privacy level for this sponsorship.

sponsor (User)

The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user.

Warning

sponsor is deprecated.

Sponsorship.sponsor will be removed. Use Sponsorship.sponsorEntity instead. Removal on 2020-10-01 UTC.

sponsorEntity (Sponsor)

The user or organization that is sponsoring, if you have permission to view them.

sponsorable (Sponsorable!)

The entity that is being sponsored.

tier (SponsorsTier)

The associated sponsorship tier.

tierSelectedAt (DateTime)

Identifies the date and time when the current tier was chosen for this sponsorship.

SponsorshipConnection

Object

A list of sponsorships either from the subject or received by the subject.

Fields for SponsorshipConnection

NameDescription

edges ([SponsorshipEdge])

A list of edges.

nodes ([Sponsorship])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

totalRecurringMonthlyPriceInCents (Int!)

The total amount in cents of all recurring sponsorships in the connection whose amount you can view. Does not include one-time sponsorships.

totalRecurringMonthlyPriceInDollars (Int!)

The total amount in USD of all recurring sponsorships in the connection whose amount you can view. Does not include one-time sponsorships.

SponsorshipEdge

Object

An edge in a connection.

Fields for SponsorshipEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Sponsorship)

The item at the end of the edge.

SponsorshipNewsletter

Object

An update sent to sponsors of a user or organization on GitHub Sponsors.

SponsorshipNewsletter Implements

Fields for SponsorshipNewsletter

NameDescription

author (User)

The author of the newsletter.

body (String!)