Skip to main content
O objeto organizacao representa um tenant na plataforma AWSales. Organizacoes sao a entidade central para billing, assinaturas e gerenciamento de equipe. Cada organizacao possui sua propria configuracao de billing, assinatura e lista de membros.
​
organizationId
string
O identificador unico da organizacao (UUIDv7).
​
billingThresholdId
string
O ID do limite de faturamento atribuido a organizacao (UUIDv7).
​
subscriptionId
string|null
O ID da assinatura ativa (UUIDv7). Null se nao houver assinatura ativa.
​
iamExternalRef
string|null
A referencia externa no provedor de identidade. Null se nao vinculado.
​
billingExternalRef
string|null
A referencia externa no provedor de pagamento. Null se nao vinculado.
​
name
string
O nome da organizacao.
​
email
string
O email de contato da organizacao.
​
currency
string
A moeda de billing da organizacao (ex: BRL, USD).
​
phone
string|null
O numero de telefone da organizacao. Null se nao fornecido.
​
address
object|null
O endereco da organizacao. Null se nao fornecido.
​
taxId
string|null
O identificador fiscal da organizacao. Null se nao fornecido.
​
taxType
string|null
O tipo de identificador fiscal (ex: CNPJ, CPF). Null se nao fornecido.
​
offboardingStatus
string
O status de offboarding da organizacao. Um de: ACTIVE, IN_RETENTION, PENDING_CANCELLATION, CANCELLED.
​
createdAt
string
Timestamp de criacao (ISO 8601).
​
updatedAt
string
Timestamp da ultima atualizacao (ISO 8601).
{
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "billingThresholdId": "019525fd-a068-7e7c-d4f0-6a8b0c2e4f6c",
  "subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
  "iamExternalRef": "org_auth_abc123",
  "billingExternalRef": "cus_Oy2pL2eZvKYlo2C",
  "name": "Acme Corp",
  "email": "billing@acme.com",
  "currency": "BRL",
  "phone": "+5511999990000",
  "address": {
    "line1": "Av. Paulista, 1000",
    "line2": "Sala 501",
    "city": "Sao Paulo",
    "state": "SP",
    "postalCode": "01310-100",
    "country": "BR"
  },
  "taxId": "12345678000190",
  "taxType": "CNPJ",
  "offboardingStatus": "ACTIVE",
  "createdAt": "2026-01-05T10:00:00.000Z",
  "updatedAt": "2026-03-15T16:45:00.000Z"
}