Sign in
gitpod.v1.BillingService

SetupEnterpriseBilling

Sets up enterprise billing for an organization.

Creates a Stripe customer, subscribes to the enterprise pricing plan, and updates the billing realm. Idempotent — safe to retry on failure.

Requires the 'change_billing_realm' account permission.

Examples

  • Setup enterprise billing (production):

    organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
email: "billing@example.com"

  • Setup enterprise billing (sandbox):

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

Request body

emailstring email nullable

email is the email address for the Stripe customer (optional)

organizationIdstring uuid required

organization_id is the ID of the organization to set up enterprise billing for

sandboxboolean

sandbox selects the sandbox billing environment. If false or unset, production is used.

setEnterpriseTierboolean

set_enterprise_tier also sets the organization tier to Enterprise. If false or unset, the organization must already be on Enterprise tier.

Response

Success

stripeCustomerIdstring required

stripe_customer_id is the created or existing Stripe customer ID

Changes