Queries
sponsorables
Users and organizations who can be sponsored via GitHub Sponsors.
Type: SponsorableItemConnection!
Arguments pour sponsorables
| Nom | 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.
Champs d’entrée pour cancelSponsorship
input(CancelSponsorshipInput!)
Champs de retour pour cancelSponsorship
| Nom | 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.
Champs d’entrée pour createSponsorship
input(CreateSponsorshipInput!)
Champs de retour pour createSponsorship
| Nom | 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.
Champs d’entrée pour createSponsorships
input(CreateSponsorshipsInput!)
Champs de retour pour createSponsorships
| Nom | 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.
Champs d’entrée pour createSponsorsListing
input(CreateSponsorsListingInput!)
Champs de retour pour createSponsorsListing
| Nom | 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.
Champs d’entrée pour createSponsorsTier
input(CreateSponsorsTierInput!)
Champs de retour pour createSponsorsTier
| Nom | 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.
Champs d’entrée pour publishSponsorsTier
input(PublishSponsorsTierInput!)
Champs de retour pour publishSponsorsTier
| Nom | 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.
Champs d’entrée pour retireSponsorsTier
input(RetireSponsorsTierInput!)
Champs de retour pour retireSponsorsTier
| Nom | 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.
Champs d’entrée pour updatePatreonSponsorability
Champs de retour pour updatePatreonSponsorability
| Nom | 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.
Champs d’entrée pour updateSponsorshipPreferences
Champs de retour pour updateSponsorshipPreferences
| Nom | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The sponsorship that was updated. |
Objects
SponsorableItemConnection
The connection type for SponsorableItem.
Champs pour SponsorableItemConnection
| Nom | 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.
Champs pour SponsorableItemEdge
| Nom | 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.
Champs pour SponsorAndLifetimeValue
| Nom | 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.
Champs pour SponsorAndLifetimeValueConnection
| Nom | 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.
Champs pour SponsorAndLifetimeValueEdge
| Nom | 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.
Champs pour SponsorConnection
| Nom | 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.
Champs pour SponsorEdge
| Nom | Description |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
SponsorsActivity
An event related to sponsorship activity.
SponsorsActivity Met en œuvre
Champs pour SponsorsActivity
| Nom | 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.
Champs pour SponsorsActivityConnection
| Nom | 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.
Champs pour SponsorsActivityEdge
| Nom | 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.
Champs pour SponsorsGoal
| Nom | 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 Met en œuvre
Champs pour Sponsorship
| Nom | 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. Avertissement
|
| 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. Avertissement
|
| 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.
Champs pour SponsorshipConnection
| Nom | 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.
Champs pour SponsorshipEdge
| Nom | 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 Met en œuvre
Champs pour SponsorshipNewsletter
| Nom | 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.
Champs pour SponsorshipNewsletterConnection
| Nom | 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.
Champs pour SponsorshipNewsletterEdge
| Nom | Description |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
SponsorsListing
A GitHub Sponsors listing.
SponsorsListing Met en œuvre
Champs pour SponsorsListing
| Nom | 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 pour
|
| 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 pour
|
| The HTTP URL for this Sponsors listing. |
SponsorsListingFeaturedItem
A record that is promoted on a GitHub Sponsors profile.
SponsorsListingFeaturedItem Met en œuvre
Champs pour SponsorsListingFeaturedItem
| Nom | 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 Met en œuvre
Champs pour SponsorsTier
| Nom | 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.
Champs pour SponsorsTierAdminInfo
| Nom | 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 pour
|
SponsorsTierConnection
The connection type for SponsorsTier.
Champs pour SponsorsTierConnection
| Nom | 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.
Champs pour SponsorsTierEdge
| Nom | 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.
Champs pour StripeConnectAccount
| Nom | 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 est implémenté par
Champs pour Sponsorable
| Nom | 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 pour
|
| 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 pour
|
| The estimated monthly GitHub Sponsors income for this user/organization in cents (USD). |
| List of users and organizations this entity is sponsoring. Arguments pour
|
| List of sponsors for this user or organization. Arguments pour
|
| Events involving this sponsorable, such as new sponsorships. Arguments pour
|
| 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 pour
|
| The sponsorship from this user/organization to the viewer; that is, the sponsorship you're receiving. Arguments pour
|
| List of sponsorship updates sent from this sponsorable to sponsors. Arguments pour
|
| The sponsorships where this user or organization is the maintainer receiving the funds. Arguments pour
|
| The sponsorships where this user or organization is the funder. Arguments pour
|
| The amount in United States cents (e.g., 500 = $5.00 USD) that this entity has spent on GitHub to fund sponsorships. Only returns a value when viewed by the user themselves or by a user who can manage sponsorships for the requested organization. Arguments pour
|
| Whether or not the viewer is able to sponsor this user/organization. |
| True if the viewer is sponsoring this user/organization. |
Enums
SponsorableOrderField
Properties by which sponsorable connections can be ordered.
Valeurs pour SponsorableOrderField.
| Nom | Description |
|---|---|
LOGIN | Order sponsorable entities by login (username). |
SponsorAndLifetimeValueOrderField
Properties by which sponsor and lifetime value connections can be ordered.
Valeurs pour SponsorAndLifetimeValueOrderField.
| Nom | Description |
|---|---|
LIFETIME_VALUE | Order results by how much money the sponsor has paid in total. |
SPONSOR_LOGIN | Order results by the sponsor's login (username). |
SPONSOR_RELEVANCE | Order results by the sponsor's relevance to the viewer. |
SponsorOrderField
Properties by which sponsor connections can be ordered.
Valeurs pour SponsorOrderField.
| Nom | Description |
|---|---|
LOGIN | Order sponsorable entities by login (username). |
RELEVANCE | Order sponsors by their relevance to the viewer. |
SponsorsActivityAction
The possible actions that GitHub Sponsors activities can represent.
Valeurs pour SponsorsActivityAction.
| Nom | Description |
|---|---|
CANCELLED_SPONSORSHIP | The activity was cancelling a sponsorship. |
NEW_SPONSORSHIP | The activity was starting a sponsorship. |
PENDING_CHANGE | The activity was scheduling a downgrade or cancellation. |
REFUND | The activity was funds being refunded to the sponsor or GitHub. |
SPONSOR_MATCH_DISABLED | The activity was disabling matching for a previously matched sponsorship. |
TIER_CHANGE | The activity was changing the sponsorship tier, either directly by the sponsor or by a scheduled/pending change. |
SponsorsActivityOrderField
Properties by which GitHub Sponsors activity connections can be ordered.
Valeurs pour SponsorsActivityOrderField.
| Nom | Description |
|---|---|
TIMESTAMP | Order activities by when they happened. |
SponsorsActivityPeriod
The possible time periods for which Sponsors activities can be requested.
Valeurs pour SponsorsActivityPeriod.
| Nom | Description |
|---|---|
ALL | Don't restrict the activity to any date range, include all activity. |
DAY | The previous calendar day. |
MONTH | The previous thirty days. |
WEEK | The previous seven days. |
SponsorsCountryOrRegionCode
Represents countries or regions for billing and residence for a GitHub Sponsors profile.
Valeurs pour SponsorsCountryOrRegionCode.
| Nom | Description |
|---|---|
AD | Andorra. |
AE | United Arab Emirates. |
AF | Afghanistan. |
AG | Antigua and Barbuda. |
AI | Anguilla. |
AL | Albania. |
AM | Armenia. |
AO | Angola. |
AQ | Antarctica. |
AR | Argentina. |
AS | American Samoa. |
AT | Austria. |
AU | Australia. |
AW | Aruba. |
AX | Åland. |
AZ | Azerbaijan. |
BA | Bosnia and Herzegovina. |
BB | Barbados. |
BD | Bangladesh. |
BE | Belgium. |
BF | Burkina Faso. |
BG | Bulgaria. |
BH | Bahrain. |
BI | Burundi. |
BJ | Benin. |
BL | Saint Barthélemy. |
BM | Bermuda. |
BN | Brunei Darussalam. |
BO | Bolivia. |
BQ | Bonaire, Sint Eustatius and Saba. |
BR | Brazil. |
BS | Bahamas. |
BT | Bhutan. |
BV | Bouvet Island. |
BW | Botswana. |
BY | Belarus. |
BZ | Belize. |
CA | Canada. |
CC | Cocos (Keeling) Islands. |
CD | Congo (Kinshasa). |
CF | Central African Republic. |
CG | Congo (Brazzaville). |
CH | Switzerland. |
CI | Côte d'Ivoire. |
CK | Cook Islands. |
CL | Chile. |
CM | Cameroon. |
CN | China. |
CO | Colombia. |
CR | Costa Rica. |
CV | Cape Verde. |
CW | Curaçao. |
CX | Christmas Island. |
CY | Cyprus. |
CZ | Czech Republic. |
DE | Germany. |
DJ | Djibouti. |
DK | Denmark. |
DM | Dominica. |
DO | Dominican Republic. |
DZ | Algeria. |
EC | Ecuador. |
EE | Estonia. |
EG | Egypt. |
EH | Western Sahara. |
ER | Eritrea. |
ES | Spain. |
ET | Ethiopia. |
FI | Finland. |
FJ | Fiji. |
FK | Falkland Islands. |
FM | Micronesia. |
FO | Faroe Islands. |
FR | France. |
GA | Gabon. |
GB | United Kingdom. |
GD | Grenada. |
GE | Georgia. |
GF | French Guiana. |
GG | Guernsey. |
GH | Ghana. |
GI | Gibraltar. |
GL | Greenland. |
GM | Gambia. |
GN | Guinea. |
GP | Guadeloupe. |
GQ | Equatorial Guinea. |
GR | Greece. |
GS | South Georgia and South Sandwich Islands. |
GT | Guatemala. |
GU | Guam. |
GW | Guinea-Bissau. |
GY | Guyana. |
HK | Hong Kong. |
HM | Heard and McDonald Islands. |
HN | Honduras. |
HR | Croatia. |
HT | Haiti. |
HU | Hungary. |
ID | Indonesia. |
IE | Ireland. |
IL | Israel. |
IM | Isle of Man. |
IN | India. |
IO | British Indian Ocean Territory. |
IQ | Iraq. |
IR | Iran. |
IS | Iceland. |
IT | Italy. |
JE | Jersey. |
JM | Jamaica. |
JO | Jordan. |
JP | Japan. |
KE | Kenya. |
KG | Kyrgyzstan. |
KH | Cambodia. |
KI | Kiribati. |
KM | Comoros. |
KN | Saint Kitts and Nevis. |
KR | Korea, South. |
KW | Kuwait. |
KY | Cayman Islands. |
KZ | Kazakhstan. |
LA | Laos. |
LB | Lebanon. |
LC | Saint Lucia. |
LI | Liechtenstein. |
LK | Sri Lanka. |
LR | Liberia. |
LS | Lesotho. |
LT | Lithuania. |
LU | Luxembourg. |
LV | Latvia. |
LY | Libya. |
MA | Morocco. |
MC | Monaco. |
MD | Moldova. |
ME | Montenegro. |
MF | Saint Martin (French part). |
MG | Madagascar. |
MH | Marshall Islands. |
MK | Macedonia. |
ML | Mali. |
MM | Myanmar. |
MN | Mongolia. |
MO | Macau. |
MP | Northern Mariana Islands. |
MQ | Martinique. |
MR | Mauritania. |
MS | Montserrat. |
MT | Malta. |
MU | Mauritius. |
MV | Maldives. |
MW | Malawi. |
MX | Mexico. |
MY | Malaysia. |
MZ | Mozambique. |
NA | Namibia. |
NC | New Caledonia. |
NE | Niger. |
NF | Norfolk Island. |
NG | Nigeria. |
NI | Nicaragua. |
NL | Netherlands. |
NO | Norway. |
NP | Nepal. |
NR | Nauru. |
NU | Niue. |
NZ | New Zealand. |
OM | Oman. |
PA | Panama. |
PE | Peru. |
PF | French Polynesia. |
PG | Papua New Guinea. |
PH | Philippines. |
PK | Pakistan. |
PL | Poland. |
PM | Saint Pierre and Miquelon. |
PN | Pitcairn. |
PR | Puerto Rico. |
PS | Palestine. |
PT | Portugal. |
PW | Palau. |
PY | Paraguay. |
QA | Qatar. |
RE | Reunion. |
RO | Romania. |
RS | Serbia. |
RU | Russian Federation. |
RW | Rwanda. |
SA | Saudi Arabia. |
SB | Solomon Islands. |
SC | Seychelles. |
SD | Sudan. |
SE | Sweden. |
SG | Singapore. |
SH | Saint Helena. |
SI | Slovenia. |
SJ | Svalbard and Jan Mayen Islands. |
SK | Slovakia. |
SL | Sierra Leone. |
SM | San Marino. |
SN | Senegal. |
SO | Somalia. |
SR | Suriname. |
SS | South Sudan. |
ST | Sao Tome and Principe. |
SV | El Salvador. |
SX | Sint Maarten (Dutch part). |
SY | Syria. |
SZ | Swaziland. |
TC | Turks and Caicos Islands. |
TD | Chad. |
TF | French Southern Lands. |
TG | Togo. |
TH | Thailand. |
TJ | Tajikistan. |
TK | Tokelau. |
TL | Timor-Leste. |
TM | Turkmenistan. |
TN | Tunisia. |
TO | Tonga. |
TR | Türkiye. |
TT | Trinidad and Tobago. |
TV | Tuvalu. |
TW | Taiwan. |
TZ | Tanzania. |
UA | Ukraine. |
UG | Uganda. |
UM | United States Minor Outlying Islands. |
US | United States of America. |
UY | Uruguay. |
UZ | Uzbekistan. |
VA | Vatican City. |
VC | Saint Vincent and the Grenadines. |
VE | Venezuela. |
VG | Virgin Islands, British. |
VI | Virgin Islands, U.S. |
VN | Vietnam. |
VU | Vanuatu. |
WF | Wallis and Futuna Islands. |
WS | Samoa. |
YE | Yemen. |
YT | Mayotte. |
ZA | South Africa. |
ZM | Zambia. |
ZW | Zimbabwe. |
SponsorsGoalKind
The different kinds of goals a GitHub Sponsors member can have.
Valeurs pour SponsorsGoalKind.
| Nom | Description |
|---|---|
MONTHLY_SPONSORSHIP_AMOUNT | The goal is about getting a certain amount in USD from sponsorships each month. |
TOTAL_SPONSORS_COUNT | The goal is about reaching a certain number of sponsors. |
SponsorshipNewsletterOrderField
Properties by which sponsorship update connections can be ordered.
Valeurs pour SponsorshipNewsletterOrderField.
| Nom | Description |
|---|---|
CREATED_AT | Order sponsorship newsletters by when they were created. |
SponsorshipOrderField
Properties by which sponsorship connections can be ordered.
Valeurs pour SponsorshipOrderField.
| Nom | Description |
|---|---|
CREATED_AT | Order sponsorship by creation time. |
SponsorshipPaymentSource
How payment was made for funding a GitHub Sponsors sponsorship.
Valeurs pour SponsorshipPaymentSource.
| Nom | Description |
|---|---|
GITHUB | Payment was made through GitHub. |
PATREON | Payment was made through Patreon. |
SponsorshipPrivacy
The privacy of a sponsorship.
Valeurs pour SponsorshipPrivacy.
| Nom | Description |
|---|---|
PRIVATE | Private. |
PUBLIC | Public. |
SponsorsListingFeaturedItemFeatureableType
The different kinds of records that can be featured on a GitHub Sponsors profile page.
Valeurs pour SponsorsListingFeaturedItemFeatureableType.
| Nom | Description |
|---|---|
REPOSITORY | A repository owned by the user or organization with the GitHub Sponsors profile. |
USER | A user who belongs to the organization with the GitHub Sponsors profile. |
SponsorsTierOrderField
Properties by which Sponsors tiers connections can be ordered.
Valeurs pour SponsorsTierOrderField.
| Nom | Description |
|---|---|
CREATED_AT | Order tiers by creation time. |
MONTHLY_PRICE_IN_CENTS | Order tiers by their monthly price in cents. |
Unions
Sponsor
Entities that can sponsor others via GitHub Sponsors.
Types possibles pour Sponsor
SponsorableItem
Entities that can be sponsored via GitHub Sponsors.
Types possibles pour SponsorableItem
SponsorsListingFeatureableItem
A record that can be featured on a GitHub Sponsors profile.
Types possibles pour SponsorsListingFeatureableItem
Input objects
BulkSponsorship
Information about a sponsorship to make for a user or organization with a GitHub Sponsors profile, as part of sponsoring many users or organizations at once.
Champs d’entrée pour BulkSponsorship
| Nom | Description |
|---|---|
| The amount to pay to the sponsorable in US dollars. Valid values: 1-12000. |
| The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given. |
| The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given. |
CancelSponsorshipInput
Autogenerated input type of CancelSponsorship.
Champs d’entrée pour CancelSponsorshipInput
| Nom | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorLogin is not given. |
| The username of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorId is not given. |
| The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given. |
| The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given. |
CreateSponsorshipInput
Autogenerated input type of CreateSponsorship.
Champs d’entrée pour CreateSponsorshipInput
| Nom | Description |
|---|---|
| The amount to pay to the sponsorable in US dollars. Required if a tierId is not specified. Valid values: 1-12000. |
| A unique identifier for the client performing the mutation. |
| Whether the sponsorship should happen monthly/yearly or just this one time. Required if a tierId is not specified. |
| Specify whether others should be able to see that the sponsor is sponsoring the sponsorable. Public visibility still does not reveal which tier is used. |
| Whether the sponsor should receive email updates from the sponsorable. |
| The ID of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorLogin is not given. |
| The username of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorId is not given. |
| The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given. |
| The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given. |
| The ID of one of sponsorable's existing tiers to sponsor at. Required if amount is not specified. |
CreateSponsorshipsInput
Autogenerated input type of CreateSponsorships.
Champs d’entrée pour CreateSponsorshipsInput
| Nom | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Specify whether others should be able to see that the sponsor is sponsoring the sponsorables. Public visibility still does not reveal the dollar value of the sponsorship. |
| Whether the sponsor should receive email updates from the sponsorables. |
| Whether the sponsorships created should continue each billing cycle for the sponsor (monthly or annually), versus lasting only a single month. Defaults to one-time sponsorships. |
| The username of the user or organization who is acting as the sponsor, paying for the sponsorships. |
| The list of maintainers to sponsor and for how much apiece. |
CreateSponsorsListingInput
Autogenerated input type of CreateSponsorsListing.
Champs d’entrée pour CreateSponsorsListingInput
| Nom | Description |
|---|---|
| The country or region where the sponsorable's bank account is located. Required if fiscalHostLogin is not specified, ignored when fiscalHostLogin is specified. |
| A unique identifier for the client performing the mutation. |
| The email address we should use to contact you about the GitHub Sponsors profile being created. This will not be shared publicly. Must be a verified email address already on your GitHub account. Only relevant when the sponsorable is yourself. Defaults to your primary email address on file if omitted. |
| The username of the supported fiscal host's GitHub organization, if you want
to receive sponsorship payouts through a fiscal host rather than directly to a
bank account. For example, |
| The URL for your profile page on the fiscal host's website, e.g., https://opencollective.com/babel or https://numfocus.org/project/bokeh. Required if fiscalHostLogin is specified. |
| Provide an introduction to serve as the main focus that appears on your GitHub Sponsors profile. It's a great opportunity to help potential sponsors learn more about you, your work, and why their sponsorship is important to you. GitHub-flavored Markdown is supported. |
| The country or region where the sponsorable resides. This is for tax purposes. Required if the sponsorable is yourself, ignored when sponsorableLogin specifies an organization. |
| The username of the organization to create a GitHub Sponsors profile for, if desired. Defaults to creating a GitHub Sponsors profile for the authenticated user if omitted. |
CreateSponsorsTierInput
Autogenerated input type of CreateSponsorsTier.
Champs d’entrée pour CreateSponsorsTierInput
| Nom | Description |
|---|---|
| The value of the new tier in US dollars. Valid values: 1-12000. |
| A unique identifier for the client performing the mutation. |
| A description of what this tier is, what perks sponsors might receive, what a sponsorship at this tier means for you, etc. |
| Whether sponsorships using this tier should happen monthly/yearly or just once. |
| Whether to make the tier available immediately for sponsors to choose. Defaults to creating a draft tier that will not be publicly visible. |
| Optional ID of the private repository that sponsors at this tier should gain read-only access to. Must be owned by an organization. |
| Optional name of the private repository that sponsors at this tier should gain read-only access to. Must be owned by an organization. Necessary if repositoryOwnerLogin is given. Will be ignored if repositoryId is given. |
| Optional login of the organization owner of the private repository that sponsors at this tier should gain read-only access to. Necessary if repositoryName is given. Will be ignored if repositoryId is given. |
| The ID of the user or organization who owns the GitHub Sponsors profile. Defaults to the current user if omitted and sponsorableLogin is not given. |
| The username of the user or organization who owns the GitHub Sponsors profile. Defaults to the current user if omitted and sponsorableId is not given. |
| Optional message new sponsors at this tier will receive. |
PublishSponsorsTierInput
Autogenerated input type of PublishSponsorsTier.
Champs d’entrée pour PublishSponsorsTierInput
| Nom | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the draft tier to publish. |
RetireSponsorsTierInput
Autogenerated input type of RetireSponsorsTier.
Champs d’entrée pour RetireSponsorsTierInput
| Nom | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the published tier to retire. |
SponsorableOrder
Ordering options for connections to get sponsorable entities for GitHub Sponsors.
Champs d’entrée pour SponsorableOrder
| Nom | Description |
|---|---|
| The ordering direction. |
| The field to order sponsorable entities by. |
SponsorAndLifetimeValueOrder
Ordering options for connections to get sponsor entities and associated USD amounts for GitHub Sponsors.
Champs d’entrée pour SponsorAndLifetimeValueOrder
| Nom | Description |
|---|---|
| The ordering direction. |
The field to order results by. |
SponsorOrder
Ordering options for connections to get sponsor entities for GitHub Sponsors.
Champs d’entrée pour SponsorOrder
| Nom | Description |
|---|---|
| The ordering direction. |
| The field to order sponsor entities by. |
SponsorsActivityOrder
Ordering options for GitHub Sponsors activity connections.
Champs d’entrée pour SponsorsActivityOrder
| Nom | Description |
|---|---|
| The ordering direction. |
| The field to order activity by. |
SponsorshipNewsletterOrder
Ordering options for sponsorship newsletter connections.
Champs d’entrée pour SponsorshipNewsletterOrder
| Nom | Description |
|---|---|
| The ordering direction. |
| The field to order sponsorship newsletters by. |
SponsorshipOrder
Ordering options for sponsorship connections.
Champs d’entrée pour SponsorshipOrder
| Nom | Description |
|---|---|
| The ordering direction. |
| The field to order sponsorship by. |
SponsorsTierOrder
Ordering options for Sponsors tiers connections.
Champs d’entrée pour SponsorsTierOrder
| Nom | Description |
|---|---|
| The ordering direction. |
| The field to order tiers by. |
UpdatePatreonSponsorabilityInput
Autogenerated input type of UpdatePatreonSponsorability.
Champs d’entrée pour UpdatePatreonSponsorabilityInput
| Nom | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Whether Patreon tiers should be shown on the GitHub Sponsors profile page, allowing potential sponsors to make their payment through Patreon instead of GitHub. |
| The username of the organization with the GitHub Sponsors profile, if any. Defaults to the GitHub Sponsors profile for the authenticated user if omitted. |
UpdateSponsorshipPreferencesInput
Autogenerated input type of UpdateSponsorshipPreferences.
Champs d’entrée pour UpdateSponsorshipPreferencesInput
| Nom | Description |
|---|---|
| A unique identifier for the client performing the mutation. |
| Specify whether others should be able to see that the sponsor is sponsoring the sponsorable. Public visibility still does not reveal which tier is used. |
| Whether the sponsor should receive email updates from the sponsorable. |
| The ID of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorLogin is not given. |
| The username of the user or organization who is acting as the sponsor, paying for the sponsorship. Required if sponsorId is not given. |
| The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given. |
| The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given. |