Sign in
gitpod.v1.BillingService

GetBillingInfo

Retrieves billing information including credit balance for an organization.

Use this method to:

  • Check available credits for the organization
  • Monitor credit usage and remaining balance
  • Display billing status in the dashboard
  • Implement usage-based alerts

Examples

  • Get billing info:

    Retrieves current credit balance and usage information.

    organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
post/gitpod.v1.BillingService/GetBillingInfo

Request body

organizationIdstring uuid required

organization_id is the ID of the organization to get billing info for

Response

Success

availableCreditsnumber double

available_credits is the remaining credits available for use

creditStatus'CREDIT_STATUS_UNSPECIFIED' | 'CREDIT_STATUS_OUT_OF_CREDITS' | 'CREDIT_STATUS_LOW_ON_CREDITS' | 'CREDIT_STATUS_HAS_CREDITS'
paymentMethodStatus'PAYMENT_METHOD_STATUS_UNSPECIFIED' | 'PAYMENT_METHOD_STATUS_NOT_SET_UP' | 'PAYMENT_METHOD_STATUS_VERIFIED'
totalCreditsnumber double

total_credits is the total amount of credits granted to the organization

usedCreditsnumber double

used_credits is the amount of credits already consumed

Changes