Magidoc

Sponsorable
Interface

Entities that can sponsor or be sponsored through GitHub Sponsors.

Fields

#

estimatedNextSponsorsPayoutInCents

Non-null

The estimated next GitHub Sponsors payout for this user/organization in cents (USD).

hasSponsorsListing

Non-null

True if this user/organization has a GitHub Sponsors listing.

isSponsoredBy

Non-null

Whether the given account is sponsoring this user/organization.

isSponsoringViewer

Non-null

True if the viewer is sponsored by this user/organization.

lifetimeReceivedSponsorshipValues

Non-null

Calculate how much each sponsor has ever paid total to this maintainer via GitHub Sponsors. Does not include sponsorships paid via Patreon.

monthlyEstimatedSponsorsIncomeInCents

Non-null

The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).

sponsoring

Non-null

List of users and organizations this entity is sponsoring.

sponsors

Non-null

List of sponsors for this user or organization.

sponsorsActivities

Non-null

Events involving this sponsorable, such as new sponsorships.

sponsorsListing

The GitHub Sponsors listing for this user or organization.

sponsorshipForViewerAsSponsor

The sponsorship from the viewer to this user/organization; that is, the sponsorship where you're the sponsor.

sponsorshipForViewerAsSponsorable

The sponsorship from this user/organization to the viewer; that is, the sponsorship you're receiving.

sponsorshipNewsletters

Non-null

List of sponsorship updates sent from this sponsorable to sponsors.

sponsorshipsAsMaintainer

Non-null

The sponsorships where this user or organization is the maintainer receiving the funds.

sponsorshipsAsSponsor

Non-null

The sponsorships where this user or organization is the funder.

totalSponsorshipAmountAsSponsorInCents

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.

viewerCanSponsor

Non-null

Whether or not the viewer is able to sponsor this user/organization.

viewerIsSponsoring

Non-null

True if the viewer is sponsoring this user/organization.

Implementations

#

Implemented by Organization , User .

Usages

#

References

#