Github API - Test Config

SponsorsTier [object]

A GitHub Sponsors tier associated with a GitHub Sponsors listing.

Implements
Node

Node [interface]

An object with an ID.

Attributes
id ID

ID of the object.

API:
Github GraphQL API
Attributes
adminInfo SponsorsTierAdminInfo

SponsorsTierAdminInfo [object]

SponsorsTier information only visible to users that can administer the associated Sponsors listing.

Attributes
isDraft Boolean

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.

isPublished Boolean

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.

isRetired Boolean

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.

sponsorships SponsorshipConnection

The sponsorships using this tier.

API:
Github GraphQL API

SponsorsTier information only visible to users that can administer the associated Sponsors listing.

closestLesserValueTier SponsorsTier

SponsorsTier [object]

A GitHub Sponsors tier associated with a GitHub Sponsors listing.

Implements
Node
Attributes

SponsorsTier information only visible to users that can administer the associated Sponsors listing.

closestLesserValueTier SponsorsTier

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.

createdAt DateTime

Identifies the date and time when the object was created.

description String

The description of the tier.

descriptionHTML HTML

The tier description rendered to HTML

id ID

The Node ID of the SponsorsTier object

isCustomAmount Boolean

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.

isOneTime Boolean

Whether this tier is only for use with one-time sponsorships.

monthlyPriceInCents Int

How much this tier costs per month in cents.

monthlyPriceInDollars Int

How much this tier costs per month in USD.

name String

The name of the tier.

sponsorsListing SponsorsListing

The sponsors listing that this tier belongs to.

updatedAt DateTime

Identifies the date and time when the object was last updated.

API:
Github GraphQL API

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.

createdAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

Identifies the date and time when the object was created.

description String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The description of the tier.

descriptionHTML HTML

HTML [scalar]

A string containing HTML code.

API:
Github GraphQL API

The tier description rendered to HTML

id ID

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.

API:
Github GraphQL API

The Node ID of the SponsorsTier object

isCustomAmount Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

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.

isOneTime Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether this tier is only for use with one-time sponsorships.

monthlyPriceInCents Int

Int [scalar]

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

API:
Github GraphQL API

How much this tier costs per month in cents.

monthlyPriceInDollars Int

Int [scalar]

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

API:
Github GraphQL API

How much this tier costs per month in USD.

name String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The name of the tier.

sponsorsListing SponsorsListing

SponsorsListing [object]

A GitHub Sponsors listing.

Implements
Node
Attributes
activeGoal SponsorsGoal

The current goal the maintainer is trying to reach with GitHub Sponsors, if any.

activeStripeConnectAccount StripeConnectAccount

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.

billingCountryOrRegion String

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.

contactEmailAddress String

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.

createdAt DateTime

Identifies the date and time when the object was created.

dashboardResourcePath URI

The HTTP path for the Sponsors dashboard for this Sponsors listing.

dashboardUrl URI

The HTTP URL for the Sponsors dashboard for this Sponsors listing.

featuredItems SponsorsListingFeaturedItem []

The records featured on the GitHub Sponsors profile.

fiscalHost Organization

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.

fullDescription String

The full description of the listing.

fullDescriptionHTML HTML

The full description of the listing rendered to HTML.

id ID

The Node ID of the SponsorsListing object

isPublic Boolean

Whether this listing is publicly visible.

name String

The listing's full name.

nextPayoutDate Date

A future date on which this listing is eligible to receive a payout.

residenceCountryOrRegion String

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.

resourcePath URI

The HTTP path for this Sponsors listing.

shortDescription String

The short description of the listing.

slug String

The short name of the listing.

sponsorable Sponsorable

The entity this listing represents who can be sponsored on GitHub Sponsors.

The tiers for this GitHub Sponsors profile.

url URI

The HTTP URL for this Sponsors listing.

API:
Github GraphQL API

The sponsors listing that this tier belongs to.

updatedAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

Identifies the date and time when the object was last updated.

API:
Github GraphQL API