Class GHMarketplacePlan

    • Constructor Detail

      • GHMarketplacePlan

        public GHMarketplacePlan()
    • Method Detail

      • getUrl

        public URL getUrl()
        Gets url.
        Returns:
        the url
      • getAccountsUrl

        public String getAccountsUrl()
        Gets accounts url.
        Returns:
        the accounts url
      • getId

        public long getId()
        Gets id.
        Returns:
        the id
      • getNumber

        public long getNumber()
        Gets number.
        Returns:
        the number
      • getName

        public String getName()
        Gets name.
        Returns:
        the name
      • getDescription

        public String getDescription()
        Gets description.
        Returns:
        the description
      • getMonthlyPriceInCents

        public long getMonthlyPriceInCents()
        Gets monthly price in cents.
        Returns:
        the monthly price in cents
      • getYearlyPriceInCents

        public long getYearlyPriceInCents()
        Gets yearly price in cents.
        Returns:
        the yearly price in cents
      • isFreeTrial

        public boolean isFreeTrial()
        Is free trial boolean.
        Returns:
        the boolean
      • getUnitName

        public String getUnitName()
        Gets unit name.
        Returns:
        the unit name
      • getState

        public String getState()
        Gets state.
        Returns:
        the state
      • getBullets

        public List<String> getBullets()
        Gets bullets.
        Returns:
        the bullets
      • listAccounts

        public GHMarketplaceListAccountBuilder listAccounts()
        Starts a builder that list any accounts associated with a plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

        You use the returned builder to set various properties, then call GHMarketplaceListAccountBuilder.createRequest() to finally list the accounts related to this plan.

        GitHub Apps must use a JWT to access this endpoint.

        OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

        Returns:
        a GHMarketplaceListAccountBuilder instance
        See Also:
        List all GitHub accounts (user or organization) on a specific plan