SponsorsActivity [object]
An event related to sponsorship activity.
Implements
Attributes
SponsorsActivityAction [enum]
The possible actions that GitHub Sponsors activities can represent.
Possible values
The activity was cancelling a sponsorship.
The activity was starting a sponsorship.
The activity was scheduling a downgrade or cancellation.
The activity was funds being refunded to the sponsor or GitHub.
The activity was disabling matching for a previously matched sponsorship.
The activity was changing the sponsorship tier, either directly by the sponsor or by a scheduled/pending change.
What action this activity indicates took place.
SponsorshipPrivacy [enum]
The privacy of a sponsorship
Possible values
Private
Public
The sponsor's current privacy level.
ID [scalar]
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
The Node ID of the SponsorsActivity object
SponsorshipPaymentSource [enum]
How payment was made for funding a GitHub Sponsors sponsorship.
Possible values
Payment was made through GitHub.
Payment was made through Patreon.
The platform that was used to pay for the sponsorship.
SponsorsTier [object]
A GitHub Sponsors tier associated with a GitHub Sponsors listing.
Implements
Attributes
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.
The tier that the sponsorship used to use, for tier change events.
Sponsor [union]
Entities that can sponsor others via GitHub Sponsors
Union
The user or organization who triggered this activity and was/is sponsoring the sponsorable.
Sponsorable [interface]
Entities that can sponsor or be sponsored through GitHub Sponsors.
Attributes
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.
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.
The estimated monthly GitHub Sponsors income for this user/organization in cents (USD).
List of users and organizations this entity is sponsoring.
List of sponsors for this user or organization.
Events involving this sponsorable, such as new sponsorships.
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.
The sponsorship from this user/organization to the viewer; that is, the sponsorship you're receiving.
List of sponsorship updates sent from this sponsorable to sponsors.
The sponsorships where this user or organization is the maintainer receiving the funds.
The sponsorships where this user or organization is the funder.
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.
Whether or not the viewer is able to sponsor this user/organization.
True if the viewer is sponsoring this user/organization.
The user or organization that is being sponsored, the maintainer.
SponsorsTier [object]
A GitHub Sponsors tier associated with a GitHub Sponsors listing.
Implements
Attributes
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.
The associated sponsorship tier.
The timestamp of this event.
Boolean [scalar]
The Boolean scalar type represents true or false.
Was this sponsorship made alongside other sponsorships at the same time from the same sponsor?