How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Gitpod gitpod.v1.BillingService API

BillingService provides billing and subscription management functionality.

Gitpod gitpod.v1.BillingService API is one of 34 APIs that Gitpod publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 37 operations across 37 paths, and defines 116 schemas. It is described by OpenAPI 3.0.0, at version v1.0.0.

Requests are made against a single base URL, https://api.gitpod.io.

37 operations 37 paths 116 schemas 37 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.0.0
Base URL
https://api.gitpod.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Gitpod gitpod.v1.BillingService API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 37

Across 37 paths, the API surfaces 37 operations — 37 POST. Each is listed below with its method, path, parameters, and response codes.

gitpod.v1.BillingService 37

BillingService provides billing and subscription management functionality.

POST
/gitpod.v1.BillingService/CancelSubscription
CancelSubscription
gitpod.v1.BillingService.CancelSubscription body → 200default
POST
/gitpod.v1.BillingService/ClearTopupFailure
ClearTopupFailure
gitpod.v1.BillingService.ClearTopupFailure body → 200default
POST
/gitpod.v1.BillingService/CompleteBillingSetup
CompleteBillingSetup
gitpod.v1.BillingService.CompleteBillingSetup body → 200default
POST
/gitpod.v1.BillingService/CorrectUsageEvents
CorrectUsageEvents
gitpod.v1.BillingService.CorrectUsageEvents body → 200default
POST
/gitpod.v1.BillingService/CreateCardVerification
CreateCardVerification
gitpod.v1.BillingService.CreateCardVerification body → 200default
POST
/gitpod.v1.BillingService/CreateCoupon
CreateCoupon
gitpod.v1.BillingService.CreateCoupon body → 200default
POST
/gitpod.v1.BillingService/CreateSubscription
CreateSubscription
gitpod.v1.BillingService.CreateSubscription body → 200default
POST
/gitpod.v1.BillingService/CreateTeamCreditAllocation
CreateTeamCreditAllocation
gitpod.v1.BillingService.CreateTeamCreditAllocation body → 200default
POST
/gitpod.v1.BillingService/DeleteTeamCreditAllocation
DeleteTeamCreditAllocation
gitpod.v1.BillingService.DeleteTeamCreditAllocation body → 200default
POST
/gitpod.v1.BillingService/GetAutoTopupSettings
GetAutoTopupSettings
gitpod.v1.BillingService.GetAutoTopupSettings body → 200default
POST
/gitpod.v1.BillingService/GetBillingInfo
GetBillingInfo
gitpod.v1.BillingService.GetBillingInfo body → 200default
POST
/gitpod.v1.BillingService/GetBillingRecord
GetBillingRecord
gitpod.v1.BillingService.GetBillingRecord body → 200default
POST
/gitpod.v1.BillingService/GetCoupon
GetCoupon
gitpod.v1.BillingService.GetCoupon body → 200default
POST
/gitpod.v1.BillingService/GetCreditConsumptionTimeSeries
GetCreditConsumptionTimeSeries
gitpod.v1.BillingService.GetCreditConsumptionTimeSeries body → 200default
POST
/gitpod.v1.BillingService/GetCreditUsageExport
GetCreditUsageExport
gitpod.v1.BillingService.GetCreditUsageExport body → 200default
POST
/gitpod.v1.BillingService/GetCreditUsageReport
GetCreditUsageReport
gitpod.v1.BillingService.GetCreditUsageReport body → 200default
POST
/gitpod.v1.BillingService/GetCumulativeCreditUsage
GetCumulativeCreditUsage
gitpod.v1.BillingService.GetCumulativeCreditUsage body → 200default
POST
/gitpod.v1.BillingService/GetEnterpriseBillingInfo
GetEnterpriseBillingInfo
gitpod.v1.BillingService.GetEnterpriseBillingInfo body → 200default
POST
/gitpod.v1.BillingService/GetStripePortalUrl
GetStripePortalUrl
gitpod.v1.BillingService.GetStripePortalUrl body → 200default
POST
/gitpod.v1.BillingService/GetStripePublishableKey
GetStripePublishableKey
gitpod.v1.BillingService.GetStripePublishableKey body → 200default
POST
/gitpod.v1.BillingService/GetTeamCreditAllocation
GetTeamCreditAllocation
gitpod.v1.BillingService.GetTeamCreditAllocation body → 200default
POST
/gitpod.v1.BillingService/GrantCredits
GrantCredits
gitpod.v1.BillingService.GrantCredits body → 200default
POST
/gitpod.v1.BillingService/InsertUsageEvents
InsertUsageEvents
gitpod.v1.BillingService.InsertUsageEvents body → 200default
POST
/gitpod.v1.BillingService/ListCoupons
ListCoupons
gitpod.v1.BillingService.ListCoupons 2 params body → 200default
POST
/gitpod.v1.BillingService/ListSubscriptions
ListSubscriptions
gitpod.v1.BillingService.ListSubscriptions 2 params body → 200default
POST
/gitpod.v1.BillingService/ReconcileBilling
ReconcileBilling
gitpod.v1.BillingService.ReconcileBilling body → 200default
POST
/gitpod.v1.BillingService/RequestRecoveryCredit
RequestRecoveryCredit
gitpod.v1.BillingService.RequestRecoveryCredit body → 200default
POST
/gitpod.v1.BillingService/SetBillingAddress
SetBillingAddress
gitpod.v1.BillingService.SetBillingAddress body → 200default
POST
/gitpod.v1.BillingService/SetBillingRealm
SetBillingRealm
gitpod.v1.BillingService.SetBillingRealm body → 200default
POST
/gitpod.v1.BillingService/SetOrganizationCreditGrant
SetOrganizationCreditGrant
gitpod.v1.BillingService.SetOrganizationCreditGrant body → 200default
POST
/gitpod.v1.BillingService/SetTaxID
SetTaxID
gitpod.v1.BillingService.SetTaxID body → 200default
POST
/gitpod.v1.BillingService/SetupBilling
SetupBilling
gitpod.v1.BillingService.SetupBilling body → 200default
POST
/gitpod.v1.BillingService/SetupEnterpriseBilling
SetupEnterpriseBilling
gitpod.v1.BillingService.SetupEnterpriseBilling body → 200default
POST
/gitpod.v1.BillingService/UpdateAutoTopupSettings
UpdateAutoTopupSettings
gitpod.v1.BillingService.UpdateAutoTopupSettings body → 200default
POST
/gitpod.v1.BillingService/UpdateBillingRecord
UpdateBillingRecord
gitpod.v1.BillingService.UpdateBillingRecord body → 200default
POST
/gitpod.v1.BillingService/UpdateSubscription
UpdateSubscription
gitpod.v1.BillingService.UpdateSubscription body → 200default
POST
/gitpod.v1.BillingService/UpdateTeamCreditAllocation
UpdateTeamCreditAllocation
gitpod.v1.BillingService.UpdateTeamCreditAllocation body → 200default

Schemas 116

The contract defines 116 schemas that model the data the API accepts and returns. The most detailed are gitpod.v1.GetBillingInfoResponse (12 properties), gitpod.v1.UsageEventInsertResult (9 properties), gitpod.v1.Coupon (9 properties), gitpod.v1.Subscription (7 properties). Each schema is shown below with its type and property counts.

gitpod.v1.GetStripePublishableKeyRequest
object
1 property 1 required
gitpod.v1.SetBillingRealmResponse
object
gitpod.v1.BillingRealm
string
gitpod.v1.CompleteBillingSetupRequest
object
2 properties 2 required
gitpod.v1.CouponConfig
object
4 properties
gitpod.v1.PaymentFailureInfo
object
4 properties
gitpod.v1.PaymentMethodStatus
string
gitpod.v1.SetTaxIDResponse
object
gitpod.v1.CreateCouponRequest
object
6 properties 2 required
gitpod.v1.ListCouponsRequest.Filter
object
4 properties
gitpod.v1.AutoTopupSettings
object
AutoTopupSettings configures automatic credit top-ups for an organization.
3 properties
gitpod.v1.RequestRecoveryCreditResponse
object
gitpod.v1.CreditsByType
object
CreditsByType contains credits consumed for a single usage type.
2 properties
gitpod.v1.GetBillingInfoResponse
object
12 properties
gitpod.v1.GetStripePortalUrlResponse
object
1 property 1 required
gitpod.v1.DeleteTeamCreditAllocationResponse
object
gitpod.v1.GetStripePublishableKeyResponse
object
1 property 1 required
gitpod.v1.GrantCreditsRequest
object
2 properties 2 required
gitpod.v1.TeamCreditAllocationInfo
object
TeamCreditAllocationInfo represents a team's credit budget allocation.
6 properties
gitpod.v1.UpdateSubscriptionResponse
object
1 property
gitpod.v1.SetOrganizationCreditGrantResponse
object
gitpod.v1.DateRange
object
DateRange specifies a time period for queries.
2 properties 2 required
gitpod.v1.InsertUsageEventsRequest
object
3 properties
gitpod.v1.CorrectUsageEventsResponse
object
1 property
gitpod.v1.CreditUsageDataPoint
object
A single data point in a credit consumption time series.
2 properties
gitpod.v1.UserCreditUsage
object
UserCreditUsage contains a single user's credit usage, broken down by type.
3 properties
gitpod.v1.ListCouponsResponse
object
2 properties
gitpod.v1.DeleteTeamCreditAllocationRequest
object
2 properties 2 required
gitpod.v1.GetBillingRecordResponse
object
1 property
gitpod.v1.GetTeamCreditAllocationRequest
object
2 properties 2 required
gitpod.v1.ListCouponsRequest
object
2 properties
gitpod.v1.UpdateTeamCreditAllocationRequest
object
3 properties 3 required
gitpod.v1.MetricConsumptionTimeSeries.Kind
string
gitpod.v1.BillingRecordSpec
object
1 property
gitpod.v1.Subscription
object
7 properties
gitpod.v1.InsertUsageEventsResponse
object
4 properties
gitpod.v1.BillingPlanSpec
object
3 properties 1 required
gitpod.v1.GetCreditConsumptionTimeSeriesRequest
object
2 properties 1 required
gitpod.v1.UsageType
string
UsageType identifies the category of usage.
gitpod.v1.SetTaxIDRequest
object
3 properties 3 required
gitpod.v1.PaymentFailureState
string
gitpod.v1.UpdateTeamCreditAllocationResponse
object
1 property
gitpod.v1.GetEnterpriseBillingInfoResponse
object
1 property
gitpod.v1.UpdateAutoTopupSettingsRequest
object
2 properties 2 required
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
2 properties
gitpod.v1.CumulativeCreditUsage
object
CumulativeCreditUsage contains cumulative credit consumption totals.
2 properties
gitpod.v1.CorrectUsageEventsRequest
object
2 properties
gitpod.v1.BillingRecordStatus
object
4 properties
gitpod.v1.CreateTeamCreditAllocationResponse
object
1 property
gitpod.v1.UpdateSubscriptionRequest
object
2 properties 2 required
gitpod.v1.GetCreditUsageReportResponse
object
3 properties
gitpod.v1.GetCreditUsageExportResponse
object
1 property
gitpod.v1.SetupBillingRequest
object
1 property 1 required
gitpod.v1.GetEnterpriseBillingInfoRequest
object
1 property 1 required
gitpod.v1.UpdateAutoTopupSettingsResponse
object
1 property
gitpod.v1.GetCouponRequest
object
2 properties 2 required
gitpod.v1.BillingAddress
object
BillingAddress represents a billing address for an organization
6 properties 4 required
gitpod.v1.TeamCreditUsage
object
TeamCreditUsage contains a single team's credit usage for a day, broken down by type.
3 properties
gitpod.v1.TopupPaymentFailureInfo
object
TopupPaymentFailureInfo contains information about a failed topup payment
2 properties
gitpod.v1.GetCumulativeCreditUsageResponse
object
4 properties
gitpod.v1.GrantCreditsResponse
object
gitpod.v1.CreateSubscriptionRequest
object
4 properties 3 required
gitpod.v1.BillingRecord
object
4 properties
gitpod.v1.Coupon
object
Coupon represents a promotional code that can be redeemed for credits
9 properties
gitpod.v1.SetBillingAddressResponse
object
gitpod.v1.GetCouponResponse
object
1 property
gitpod.v1.SetBillingAddressRequest
object
3 properties 3 required
gitpod.v1.BillingPlanStatus
object
4 properties 1 required
gitpod.v1.UpdateBillingRecordRequest
object
3 properties 2 required
gitpod.v1.SetBillingRealmRequest
object
2 properties 2 required
gitpod.v1.ClearTopupFailureResponse
object
gitpod.v1.CreateSubscriptionResponse
object
1 property
gitpod.v1.RequestRecoveryCreditRequest
object
1 property 1 required
gitpod.v1.UsageEventInsertResult
object
9 properties
gitpod.v1.CancelSubscriptionRequest
object
2 properties 2 required
gitpod.v1.CancelSubscriptionResponse
object
gitpod.v1.ListSubscriptionsRequest
object
1 property 1 required
gitpod.v1.SetupEnterpriseBillingRequest
object
5 properties 1 required
gitpod.v1.GetCreditConsumptionTimeSeriesResponse
object
1 property
gitpod.v1.GetBillingRecordRequest
object
1 property
gitpod.v1.SetOrganizationCreditGrantRequest
object
2 properties 2 required
gitpod.v1.GetBillingInfoRequest
object
1 property 1 required
gitpod.v1.GetCreditUsageExportRequest
object
2 properties 2 required
gitpod.v1.DailyCreditUsage
object
DailyCreditUsage contains credit usage for a single day.
4 properties
gitpod.v1.ListSubscriptionsResponse
object
1 property
gitpod.v1.BillingPlanKind
string
gitpod.v1.UpdateBillingRecordResponse
object
gitpod.v1.SubscriptionType
string
gitpod.v1.CreateCardVerificationResponse
object
gitpod.v1.GetCreditUsageReportRequest
object
3 properties 2 required
gitpod.v1.SetupBillingResponse
object
2 properties 2 required
gitpod.v1.GetTeamCreditAllocationResponse
object
1 property
gitpod.v1.SetupEnterpriseBillingResponse
object
1 property 1 required
gitpod.v1.GetStripePortalUrlRequest
object
1 property 1 required
gitpod.v1.CreditCardVerificationStatus
string
gitpod.v1.MetricConsumptionTimeSeries
object
Daily OCU consumption for a single metric category.
3 properties
gitpod.v1.CompleteBillingSetupResponse
object
4 properties
gitpod.v1.ReconcileBillingRequest
object
1 property 1 required
gitpod.v1.CreditStatus
string
gitpod.v1.PaginationRequest
object
2 properties
gitpod.v1.UsageEventInput
object
6 properties
gitpod.v1.TeamCumulativeCreditUsage
object
TeamCumulativeCreditUsage contains a team's cumulative credit usage and allocation.
4 properties
gitpod.v1.BillingRecordMetadata
object
4 properties
gitpod.v1.ReconcileBillingResponse
object
gitpod.v1.PaginationResponse
object
1 property
gitpod.v1.ClearTopupFailureRequest
object
1 property 1 required
google.protobuf.Timestamp
string
A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond res…
gitpod.v1.GetAutoTopupSettingsRequest
object
1 property 1 required
gitpod.v1.CreateCardVerificationRequest
object
4 properties 1 required
gitpod.v1.SubscriptionStatus
string
gitpod.v1.CreateCouponResponse
object
1 property
gitpod.v1.GetCumulativeCreditUsageRequest
object
2 properties 1 required
gitpod.v1.UsageEventCorrectionResult
object
3 properties
gitpod.v1.GetAutoTopupSettingsResponse
object
1 property
gitpod.v1.PaymentMethodVerificationStatus
object
2 properties
gitpod.v1.CreateTeamCreditAllocationRequest
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitpod-gitpod-v1-billingservice-api-openapi.yml Raw ↑

Other APIs Gitpod publishes across the network.

Gitpod Organizations API
Gitpod Projects API
Gitpod Accounts and Billing API
Gitpod gitpod.v1.AccountService API
Gitpod gitpod.v1.AgentSecurityService API
Gitpod gitpod.v1.AgentService API
Gitpod gitpod.v1.EditorService API
Gitpod gitpod.v1.EnvironmentAutomationService API
Gitpod gitpod.v1.EnvironmentService API
Gitpod gitpod.v1.ErrorsService API
Gitpod gitpod.v1.EventService API
Gitpod gitpod.v1.GatewayService API
Where this information came from

This is an independent, third-party profile of Gitpod gitpod.v1.BillingService API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.