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. |