GET /teams/{teamId}/billing/profile
Dados fiscais do time (ou vazio)
- Access: Team member
- Service:
https://api-billing.axuz.net
Accepted authentication
sessionCookie— Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.bearerSession— JWT de acesso da sessão em `Authorization: Bearer`.
Responde GET /teams/{teamId}/billing/profile devolvendo os dados cadastrais (razão social, CNPJ, endereço, etc.) pra emissão de nota fiscal e cobrança. Efeito: SELECT em billing_profiles. Se não existe row, devolve profile vazio (client pode PUT depois).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
teamId | path | string | yes |
Responses
200
profile (vazio se nunca cadastrou)
| Name | Type | Required | Description |
|---|---|---|---|
team_id | string<uuid> | no | |
legal_name | string | no | |
tax_id | string | no | |
billing_email | string | no | |
billing_phone | string | no | |
address_line1 | string | no | |
address_line2 | string | no | |
city | string | no | |
state | string | no | |
postal_code | string | no | |
country | string | no | |
created_at | string<date-time> | no | |
updated_at | string<date-time> | no |
400
input inválido
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
401
Sem credencial valida
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
403
Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
429
Limite de requisições excedido.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
500
erro interno
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
Examples
"Try it" is turned off in this reference. Use the examples with your test credential.
curl
curl -sS -X GET 'https://api-billing.axuz.net/teams/TEAM_ID/billing/profile' \
-H "Authorization: Bearer $AXUZ_TOKEN"Node.js
const res = await fetch("https://api-billing.axuz.net/teams/TEAM_ID/billing/profile", {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());Python
import os
import requests
res = requests.request(
"GET",
"https://api-billing.axuz.net/teams/TEAM_ID/billing/profile",
headers={
"Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
},
timeout=30,
)
res.raise_for_status()
print(res.json())