Magidoc

CreateSponsorsTierInput
Input Object

Autogenerated input type of CreateSponsorsTier

Fields

#

amount

Int !
Non-null

The value of the new tier in US dollars. Valid values: 1-12000.

clientMutationId

String

A unique identifier for the client performing the mutation.

description

String !
Non-null

A description of what this tier is, what perks sponsors might receive, what a sponsorship at this tier means for you, etc.

isRecurring

Boolean

Whether sponsorships using this tier should happen monthly/yearly or just once.

Default: true

publish

Boolean

Whether to make the tier available immediately for sponsors to choose. Defaults to creating a draft tier that will not be publicly visible.

repositoryId

ID

Optional ID of the private repository that sponsors at this tier should gain read-only access to. Must be owned by an organization.

repositoryName

String

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.

repositoryOwnerLogin

String

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.

sponsorableId

ID

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.

sponsorableLogin

String

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.

welcomeMessage

String

Optional message new sponsors at this tier will receive.

Usages

#

References

#

  • Argument input of field createSponsorsTier from type Mutation