Skip to main content
API · Billing POST /api/v1/billing/portal Requires the GV.APIOwner application role, or a higher role (Owner > Contributor > Reader). Operation ID · create_billing_portal

Request example

Authentication and access

  • Required role: GV.APIOwner
  • Data classification: metadata
  • Side effects: none
Use an authentication scheme declared below. Ordinary workloads use application tokens; signed-in users use delegated tokens and Organization membership. Activation and invitation acceptance require a person, and execution callbacks require their registered identity.
  • Microsoft Entra delegated user token
  • Microsoft Entra application token

Parameters

Idempotency-Key

header Required Required caller-chosen retry identity. Use 1-128 visible ASCII characters and reuse it only for an exact retry of this request. string minimum length: 1 · maximum length: 128

Responses

This guide summarizes response status codes and headers. Retrieve the deployed, authenticated OpenAPI document for the exact response body schemas and examples. The API also provides an authenticated Swagger UI; opening it in a browser does not automatically attach a bearer token. Error responses use application/problem+json. The response’s stable code and type map to the error-code reference.

200

Successful Response

400

The request cannot be satisfied in the current state.

401

A valid Microsoft Entra bearer token is required.

403

The authenticated principal does not have the required role.

409

The operation conflicts with current resource or Azure state.

422

Validation Error

429

The bounded application request rate was exceeded.

Headers

  • Retry-After: Seconds to wait before retrying. integerminimum: 1

503

A required dependency is temporarily unavailable.

Headers

  • Retry-After: Seconds to wait before retrying. integerminimum: 1