Skip to main content
GET
Leia o perfil de faturamento da organização
Requer a ação do IAM billing:GetBillingProfile. Consulte permissões de faturamento para obter a lista completa, o que cada uma cobre e um exemplo de política.

Autorizações

Authorization
string
header
obrigatório

Um token bearer OAuth 2.0, enviado como Authorization: Bearer <token>. Esta é a forma recomendada de autenticação.

Obtenha o token trocando o par de chaves de acesso de uma conta de serviço em POST /v1/oauth/token com grant_type=client_credentials. Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis com OAuth podem obter e renovar o token para você.

Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso também serve como credencial AWS SigV4 para o endpoint de objetos compatível com S3, que aceita somente esse método de autenticação.

Resposta

Detalhes de faturamento salvos ou um rascunho incompleto. O cliente pré-preenche o e-mail de faturamento do usuário conectado.

Destinatário de faturamento da organização. Os rascunhos incompletos são salvos; pronto se torna verdadeiro somente depois que todos os campos específicos do país são válidos. A nova integração é concluída após essa etapa.

customer_type
enum<string>
Opções disponíveis:
,
individual,
company
company_name
string

Nome legal completo do indivíduo ou empresa.

Maximum string length: 75
country
string

Códigos de país ISO 3166-1 alpha-2.

Required string length: 2
Exemplo:

"BR"

tax_id
string

CPF para um indivíduo brasileiro ou CNPJ para uma empresa brasileira. Os dígitos de verificação são validados.

foreign_tax_id
string

Identificador estrangeiro; não validado como documento brasileiro.

Maximum string length: 50
no_tax_id_reason
string

Necessário para um destinatário estrangeiro sem identificação fiscal.

Maximum string length: 100
email
string<email>

E-mail de cobrança para entrega de fatura fiscal. O formulário de integração pré-preenche isso a partir do e-mail do usuário conectado.

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

Código de município de sete dígitos do IBGE, necessário para um beneficiário brasileiro.

Exemplo:

"3550308"

state
string

UF de duas letras para o Brasil; estado/província de forma livre no exterior.

Maximum string length: 100
postal_code
string

CEP de oito dígitos para o Brasil; código postal internacional opcional no exterior.

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