Queries
sponsorables
Users and organizations who can be sponsored via GitHub Sponsors.
Type: SponsorableItemConnection!
Arguments for sponsorables
| Name | Description |
|---|---|
| Returns the elements in the list that come after the specified cursor. |
| Returns the elements in the list that come before the specified cursor. |
| 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: |
| 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. |
| Returns the first n elements from the list. |
| Returns the last n elements from the list. |
| 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 |
| Ordering options for users and organizations returned from the connection. |
| 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
Cancel an active sponsorship.
Input fields for cancelSponsorship
input(CancelSponsorshipInput!)
Return fields for cancelSponsorship
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The tier that was being used at the time of cancellation. |
createSponsorship
Start a new sponsorship of a maintainer in GitHub Sponsors, or reactivate a past sponsorship.
Input fields for createSponsorship
input(CreateSponsorshipInput!)
Return fields for createSponsorship
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The sponsorship that was started. |
createSponsorships
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
input(CreateSponsorshipsInput!)
Return fields for createSponsorships
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The users and organizations who received a sponsorship. |
createSponsorsListing
Create a GitHub Sponsors profile to allow others to sponsor you or your organization.
Input fields for createSponsorsListing
input(CreateSponsorsListingInput!)
Return fields for createSponsorsListing
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new GitHub Sponsors profile. |
createSponsorsTier
Create a new payment tier for your GitHub Sponsors profile.
Input fields for createSponsorsTier
input(CreateSponsorsTierInput!)
Return fields for createSponsorsTier
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new tier. |
publishSponsorsTier
Publish an existing sponsorship tier that is currently still a draft to a GitHub Sponsors profile.
Input fields for publishSponsorsTier
input(PublishSponsorsTierInput!)
Return fields for publishSponsorsTier
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The tier that was published. |
retireSponsorsTier
Retire a published payment tier from your GitHub Sponsors profile so it cannot be used to start new sponsorships.
Input fields for retireSponsorsTier
input(RetireSponsorsTierInput!)
Return fields for retireSponsorsTier
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The tier that was retired. |
updatePatreonSponsorability
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
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The GitHub Sponsors profile. |
updateSponsorshipPreferences
Change visibility of your sponsorship and opt in or out of email updates from the maintainer.
Input fields for updateSponsorshipPreferences
Return fields for updateSponsorshipPreferences
| Name | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The sponsorship that was updated. |
Objects
SponsorableItemConnection
The connection type for SponsorableItem.
Fields for SponsorableItemConnection
| Name | Description |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
SponsorableItemEdge
An edge in a connection.
Fields for SponsorableItemEdge
| Name | Description |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
SponsorAndLifetimeValue
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
| Name | Description |
|---|---|
| The amount in cents. |
| The amount in USD, formatted as a string. |
| The sponsor's GitHub account. |
| The maintainer's GitHub account. |
SponsorAndLifetimeValueConnection
The connection type for SponsorAndLifetimeValue.
Fields for SponsorAndLifetimeValueConnection
| Name | Description |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
SponsorAndLifetimeValueEdge
An edge in a connection.
Fields for SponsorAndLifetimeValueEdge
| Name | Description |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
SponsorConnection
A list of users and organizations sponsoring someone via GitHub Sponsors.
Fields for SponsorConnection
| Name | Description |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
SponsorEdge
Represents a user or organization who is sponsoring someone in GitHub Sponsors.
Fields for SponsorEdge
| Name | Description |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
SponsorsActivity
An event related to sponsorship activity.
SponsorsActivity Implements
Fields for SponsorsActivity
| Name | Description |
|---|---|
| What action this activity indicates took place. |
| The sponsor's current privacy level. |
| The Node ID of the SponsorsActivity object. |
| The platform that was used to pay for the sponsorship. |
| The tier that the sponsorship used to use, for tier change events. |
| The user or organization who triggered this activity and was/is sponsoring the sponsorable. |
| The user or organization that is being sponsored, the maintainer. |
| The associated sponsorship tier. |
| The timestamp of this event. |
| Was this sponsorship made alongside other sponsorships at the same time from the same sponsor?. |
SponsorsActivityConnection
The connection type for SponsorsActivity.
Fields for SponsorsActivityConnection
| Name | Description |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
SponsorsActivityEdge
An edge in a connection.
Fields for SponsorsActivityEdge
| Name | Description |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
SponsorsGoal
A goal associated with a GitHub Sponsors listing, representing a target the sponsored maintainer would like to attain.
Fields for SponsorsGoal
| Name | Description |
|---|---|
| A description of the goal from the maintainer. |
| What the objective of this goal is. |
| The percentage representing how complete this goal is, between 0-100. |
| 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. |
| A brief summary of the kind and target value of this goal. |
Sponsorship
A sponsorship relationship between a sponsor and a maintainer.
Sponsorship Implements
Fields for Sponsorship
| Name | Description |
|---|---|
| Identifies the date and time when the object was created. |
| The Node ID of the Sponsorship object. |
| Whether the sponsorship is active. False implies the sponsor is a past sponsor of the maintainer, while true implies they are a current sponsor. |
| Whether this sponsorship represents a one-time payment versus a recurring sponsorship. |
| 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. |
| The entity that is being sponsored. Warning
|
| The platform that was most recently used to pay for the sponsorship. |
| The privacy level for this sponsorship. |
| The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user. Warning
|
| The user or organization that is sponsoring, if you have permission to view them. |
| The entity that is being sponsored. |
| The associated sponsorship tier. |
| Identifies the date and time when the current tier was chosen for this sponsorship. |
SponsorshipConnection
A list of sponsorships either from the subject or received by the subject.
Fields for SponsorshipConnection
| Name | Description |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
| The total amount in cents of all recurring sponsorships in the connection whose amount you can view. Does not include one-time sponsorships. |
| The total amount in USD of all recurring sponsorships in the connection whose amount you can view. Does not include one-time sponsorships. |
SponsorshipEdge
An edge in a connection.
Fields for SponsorshipEdge
| Name | Description |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
SponsorshipNewsletter
An update sent to sponsors of a user or organization on GitHub Sponsors.
SponsorshipNewsletter Implements
Fields for SponsorshipNewsletter
| Name | Description |
|---|---|
| The author of the newsletter. |
| The contents of the newsletter, the message the sponsorable wanted to give. |
| Identifies the date and time when the object was created. |
| The Node ID of the SponsorshipNewsletter object. |
| Indicates if the newsletter has been made available to sponsors. |
| The user or organization this newsletter is from. |
| The subject of the newsletter, what it's about. |
| Identifies the date and time when the object was last updated. |
SponsorshipNewsletterConnection
The connection type for SponsorshipNewsletter.
Fields for SponsorshipNewsletterConnection
| Name | Description |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
SponsorshipNewsletterEdge
An edge in a connection.
Fields for SponsorshipNewsletterEdge
| Name | Description |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
SponsorsListing
A GitHub Sponsors listing.
SponsorsListing Implements
Fields for SponsorsListing
| Name | Description |
|---|---|
| The current goal the maintainer is trying to reach with GitHub Sponsors, if any. |
| The Stripe Connect account currently in use for payouts for this Sponsors listing, if any. Will only return a value when queried by the maintainer themselves, or by an admin of the sponsorable organization. |
| The name of the country or region with the maintainer's bank account or fiscal host. Will only return a value when queried by the maintainer themselves, or by an admin of the sponsorable organization. |
| The email address used by GitHub to contact the sponsorable about their GitHub Sponsors profile. Will only return a value when queried by the maintainer themselves, or by an admin of the sponsorable organization. |
| Identifies the date and time when the object was created. |
| The HTTP path for the Sponsors dashboard for this Sponsors listing. |
| The HTTP URL for the Sponsors dashboard for this Sponsors listing. |
| The records featured on the GitHub Sponsors profile. Arguments for
|
| The fiscal host used for payments, if any. Will only return a value when queried by the maintainer themselves, or by an admin of the sponsorable organization. |
| The full description of the listing. |
| The full description of the listing rendered to HTML. |
| The Node ID of the SponsorsListing object. |
| Whether this listing is publicly visible. |
| The listing's full name. |
| A future date on which this listing is eligible to receive a payout. |
| The name of the country or region where the maintainer resides. Will only return a value when queried by the maintainer themselves, or by an admin of the sponsorable organization. |
| The HTTP path for this Sponsors listing. |
| The short description of the listing. |
| The short name of the listing. |
| The entity this listing represents who can be sponsored on GitHub Sponsors. |
| The tiers for this GitHub Sponsors profile. Arguments for
|
| The HTTP URL for this Sponsors listing. |
SponsorsListingFeaturedItem
A record that is promoted on a GitHub Sponsors profile.
SponsorsListingFeaturedItem Implements
Fields for SponsorsListingFeaturedItem
| Name | Description |
|---|---|
| Identifies the date and time when the object was created. |
| Will either be a description from the sponsorable maintainer about why they featured this item, or the item's description itself, such as a user's bio from their GitHub profile page. |
| The record that is featured on the GitHub Sponsors profile. |
| The Node ID of the SponsorsListingFeaturedItem object. |
| The position of this featured item on the GitHub Sponsors profile with a lower position indicating higher precedence. Starts at 1. |
| The GitHub Sponsors profile that features this record. |
| Identifies the date and time when the object was last updated. |
SponsorsTier
A GitHub Sponsors tier associated with a GitHub Sponsors listing.
SponsorsTier Implements
Fields for SponsorsTier
| Name | Description |
|---|---|
| SponsorsTier information only visible to users that can administer the associated Sponsors listing. |
| Get a different tier for this tier's maintainer that is at the same frequency as this tier but with an equal or lesser cost. Returns the published tier with the monthly price closest to this tier's without going over. |
| Identifies the date and time when the object was created. |
| The description of the tier. |
| The tier description rendered to HTML. |
| The Node ID of the SponsorsTier object. |
| Whether this tier was chosen at checkout time by the sponsor rather than defined ahead of time by the maintainer who manages the Sponsors listing. |
| Whether this tier is only for use with one-time sponsorships. |
| How much this tier costs per month in cents. |
| How much this tier costs per month in USD. |
| The name of the tier. |
| The sponsors listing that this tier belongs to. |
| Identifies the date and time when the object was last updated. |
SponsorsTierAdminInfo
SponsorsTier information only visible to users that can administer the associated Sponsors listing.
Fields for SponsorsTierAdminInfo
| Name | Description |
|---|---|
| Indicates whether this tier is still a work in progress by the sponsorable and not yet published to the associated GitHub Sponsors profile. Draft tiers cannot be used for new sponsorships and will not be in use on existing sponsorships. Draft tiers cannot be seen by anyone but the admins of the GitHub Sponsors profile. |
| Indicates whether this tier is published to the associated GitHub Sponsors profile. Published tiers are visible to anyone who can see the GitHub Sponsors profile, and are available for use in sponsorships if the GitHub Sponsors profile is publicly visible. |
| Indicates whether this tier has been retired from the associated GitHub Sponsors profile. Retired tiers are no longer shown on the GitHub Sponsors profile and cannot be chosen for new sponsorships. Existing sponsorships may still use retired tiers if the sponsor selected the tier before it was retired. |
| The sponsorships using this tier. Arguments for
|
SponsorsTierConnection
The connection type for SponsorsTier.
Fields for SponsorsTierConnection
| Name | Description |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
SponsorsTierEdge
An edge in a connection.
Fields for SponsorsTierEdge
| Name | Description |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
StripeConnectAccount
A Stripe Connect account for receiving sponsorship funds from GitHub Sponsors.
Fields for StripeConnectAccount
| Name | Description |
|---|---|
| The account number used to identify this Stripe Connect account. |
| The name of the country or region of an external account, such as a bank account, tied to the Stripe Connect account. Will only return a value when queried by the maintainer of the associated GitHub Sponsors profile themselves, or by an admin of the sponsorable organization. |
| The name of the country or region of the Stripe Connect account. Will only return a value when queried by the maintainer of the associated GitHub Sponsors profile themselves, or by an admin of the sponsorable organization. |
| Whether this Stripe Connect account is currently in use for the associated GitHub Sponsors profile. |
| The GitHub Sponsors profile associated with this Stripe Connect account. |
| The URL to access this Stripe Connect account on Stripe's website. |
Interfaces
Sponsorable
Entities that can sponsor or be sponsored through GitHub Sponsors.
Sponsorable is implemented by
Fields for Sponsorable
| Name | Description |
|---|---|
| The estimated next GitHub Sponsors payout for this user/organization in cents (USD). |
| True if this user/organization has a GitHub Sponsors listing. |
| Whether the given account is sponsoring this user/organization. Arguments for
|
| True if the viewer is sponsored by this user/organization. |
| Calculate how much each sponsor has ever paid total to this maintainer via GitHub Sponsors. Does not include sponsorships paid via Patreon. Arguments for
|
| The estimated monthly GitHub Sponsors income for this user/organization in cents (USD). |
| List of users and organizations this entity is sponsoring. Arguments for
|
| List of sponsors for this user or organization. Arguments for
|
| Events involving this sponsorable, such as new sponsorships. Arguments for
|
| The GitHub Sponsors listing for this user or organization. |
| The sponsorship from the viewer to this user/organization; that is, the sponsorship where you're the sponsor. Arguments for
|
| The sponsorship from this user/organization to the viewer; that is, the sponsorship you're receiving. Arguments for
|
| List of sponsorship updates sent from this sponsorable to sponsors. Arguments for
|