Skip to main content
GET
Read the organization billing profile
Requires the IAM action billing:GetBillingProfile. See BILLING permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Response

Saved billing details or an incomplete draft. The client prefills the billing email from the signed-in user.

Organization billing recipient. Incomplete drafts are saved; ready becomes true only after all country-specific fields are valid. New onboarding completes after this step.

customer_type
enum<string>
Available options:
,
individual,
company
company_name
string

Full legal name of the individual or company.

Maximum string length: 75
country
string

ISO 3166-1 alpha-2 country code.

Required string length: 2
Example:

"BR"

tax_id
string

CPF for a Brazilian individual or CNPJ for a Brazilian company. Check digits are validated.

foreign_tax_id
string

Foreign identifier; not validated as a Brazilian document.

Maximum string length: 50
no_tax_id_reason
string

Required for a foreign recipient without a tax identifier.

Maximum string length: 100
email
string<email>

Billing email for fiscal invoice delivery. The onboarding form prefills this from the signed-in user's email.

Maximum string length: 75
phone
string
Maximum string length: 50
street_name
string
Maximum string length: 50
street_number
string
Maximum string length: 10
complement
string
Maximum string length: 30
neighborhood
string
Maximum string length: 30
city
string
Maximum string length: 100
municipality_code
string

Seven-digit IBGE municipality code, required for a Brazilian recipient.

Example:

"3550308"

state
string

Two-letter UF for Brazil; free-form state/province abroad.

Maximum string length: 100
postal_code
string

Eight-digit CEP for Brazil; optional international postal code abroad.

Maximum string length: 20
ready
boolean
read-only
missing_fields
string[]
read-only