Github API - Test Config

mutation createSponsorship

Start a new sponsorship of a maintainer in GitHub Sponsors, or reactivate a past sponsorship.

Arguments
input CreateSponsorshipInput

CreateSponsorshipInput [input]

Autogenerated input type of CreateSponsorship

Attributes
amount Int

The amount to pay to the sponsorable in US dollars. Required if a tierId is not specified. Valid values: 1-12000.

clientMutationId String

A unique identifier for the client performing the mutation.

isRecurring Boolean

Whether the sponsorship should happen monthly/yearly or just this one time. Required if a tierId is not specified.

privacyLevel SponsorshipPrivacy

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.

receiveEmails Boolean

Whether the sponsor should receive email updates from the sponsorable.

sponsorId ID

The ID of the user or organization who is acting as the sponsor, paying for
the sponsorship. Required if sponsorLogin is not given.

sponsorLogin String

The username of the user or organization who is acting as the sponsor, paying
for the sponsorship. Required if sponsorId is not given.

sponsorableId ID

The ID of the user or organization who is receiving the sponsorship. Required if sponsorableLogin is not given.

sponsorableLogin String

The username of the user or organization who is receiving the sponsorship. Required if sponsorableId is not given.

tierId ID

The ID of one of sponsorable's existing tiers to sponsor at. Required if amount is not specified.

API:
Github GraphQL API

Parameters for CreateSponsorship

Returns
CreateSponsorshipPayload

CreateSponsorshipPayload [object]

Autogenerated return type of CreateSponsorship

Attributes
clientMutationId String

A unique identifier for the client performing the mutation.

sponsorship Sponsorship

The sponsorship that was started.

API:
Github GraphQL API
API:
Github GraphQL API