Preview — pending review
This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.
Read the tenant's billing identity
Returns the billing identity of the scope's tenant as a one-element collection: legal name,
tax / VAT id, invoice address and the read-only billing email, display name and website. It is the SAME
source the invoice "Bill To" is frozen from at cycle close (the tax id on the tenant, the address on the
tenant owner's profile), so what the customer sees here is what the next invoice carries.
Validation: caller must be able to read billing in the scope (else 403 FORBIDDEN); an unknown or
unreachable scopeId maps to 404 NOT_FOUND.
Async & state: Synchronous read; no state change.
Errors: 401 missing/expired session; 403 no billing read permission; 404 unknown scope; 500 internal
failure.
bearerTokenAuthorizationBearer <token>An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.
scopeId*stringOpaque ownership+authorization scope resolving to tenant + subscription + project.
The tenant's billing identity (exactly one record).
application/json- response
data*array<>meta*Pagination envelope metadata. List responses are always { data, meta } — never a naked array.
curl -X GET "https://example.com/scopes/string/settings/company"{ "data": [ { "id": "string", "legalName": "Acme Technologies Ltd", "displayName": "Acme Corp", "website": "https://acme.io", "taxId": "GB 432 5089 17", "billingEmail": "billing@acme.example", "addressLine1": "1 Finsbury Avenue", "city": "London", "postalCode": "EC2M 2PF", "country": "GB" } ], "meta": { "page": 1, "pageSize": 1, "total": 0, "hasNext": true }}