Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xata Billing API

Internal organization billing operations

Xata Billing API is one of 12 APIs that Xata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Billing. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 5 paths, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://api.xata.tech.

6 operations 5 paths 13 schemas 3 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.xata.tech
Authentication
OpenID Connect, API Key, OAuth 2.0, API Key
Contact
help@xata.io
Resource Areas
1

Authentication & Security 4

Xata Billing API declares 4 security schemes for authenticating requests. It supports OpenID Connect (oidc) discovered at https://auth.xata.io/realms/xata/.well-known/openid-configuration. An API key is passed in the header as Authorization (apiKey). It supports OAuth 2.0 (xata) using the implicit flow, exposing 13 scopes. An API key is passed in the header as Connection-String (branchConnectionString).

  • apiKey — API key authentication using Bearer token format: Bearer
  • branchConnectionString — Branch PostgreSQL connection string (postgres://user:pass@{branch}.{region}.xata.tech/db), including the embedded password. The hostname selects the target bra…

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Billing 6

Internal organization billing operations

POST
/organizations/{organizationID}/billing/checkout-session
Create a billing checkout session
createBillingCheckoutSession 1 param → 2004004014035XX
POST
/organizations/{organizationID}/billing/payment-method-session
Create a billing payment method session
createBillingPaymentMethodSession 1 param → 2004004014035XX
GET
/organizations/{organizationID}/billing/customer
Get billing customer details
getBillingCustomer 1 param → 2004014034045XX
PATCH
/organizations/{organizationID}/billing/customer
Update billing customer details
updateBillingCustomer 1 param body → 2004004014034045XX
GET
/organizations/{organizationID}/billing/invoices
List billing invoices
getBillingInvoices 3 params → 2004004014034045XX
GET
/organizations/{organizationID}/billing/invoices/upcoming
Get upcoming billing invoice
getBillingUpcomingInvoice 1 param → 2004014034045XX

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are BillingCreditDetails (8 properties), BillingUpcomingInvoiceResponse (7 properties), BillingInvoice (7 properties), BillingCredit (6 properties). Each schema is shown below with its type and property counts.

BillingCreditDetails
object
8 properties 8 required
UpdateBillingCustomerRequest
object
1 property 1 required
PaginationMetadata
object
2 properties 2 required
BillingInvoicesResponse
object
2 properties 2 required
BillingCustomerResponse
object
5 properties 5 required
BillingInvoice
object
7 properties 7 required
BillingPaymentMethodSessionResponse
object
1 property 1 required
OrganizationID
string
BillingCheckoutSessionResponse
object
1 property 1 required
BillingPaymentMethodCard
object
4 properties 4 required
BillingPaymentMethod
object
1 property 1 required
BillingUpcomingInvoiceResponse
object
7 properties 7 required
BillingCredit
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xata-billing-api-openapi.yml Raw ↑

Other APIs Xata publishes across the network.

Xata API Keys API
Xata Branches API
Xata Gateway API
Xata GitHub App API
Xata Logs API
Xata Marketplace API
Xata Metrics API
Xata Organizations API
Xata Projects API
Xata Projects Webhooks API
Xata Webhooks API