Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt

Use this file to discover all available pages before exploring further.

Cria uma nova organização e automaticamente associa o usuário autenticado como membro. O usuário deve ter um registro em public.users (ser um admin registrado).

​
Autenticação

Requer token de usuário (JWT Supabase) via header Authorization: Bearer.

​
Corpo da Requisição

​
name
string
required
Nome da organização
​
terms
boolean
required
Aceite dos termos de uso (deve ser true)
​
bio
string
Biografia ou descrição da organização
​
company
string
Nome da empresa
​
blog
string
URL do blog
​
location
string
Localização
​
email
string
E-mail de contato público
​
twitter_username
string
Nome de usuário no Twitter/X
​
website
string
URL do site
​
avatar_url
string
URL do avatar
​
profile_settings
object
Configurações de perfil
​
feature_settings
object
Configurações de funcionalidades
​
subscription_settings
object
Configurações de assinaturas
​
notification_settings
object
Configurações de notificações
​
socials
array
Links de redes sociais

​
Resposta

Retorna o objeto completo da organização criada com status HTTP 201 Created.
​
id
string
ID único da organização
​
name
string
Nome da organização
​
status
string
Status inicial: created
​
customer_invoice_prefix
string
Prefixo das faturas (gerado automaticamente a partir do nome)
​
customer_invoice_next_number
integer
Próximo número de fatura (inicia em 1)
​
subscription_settings
object
Configurações padrão de assinaturas
​
notification_settings
object
Configurações padrão de notificações
​
created_at
string
Data de criação (ISO 8601)

​
Erros

CódigoDescrição
400name, taxpayer_id ou taxpayer_type ausentes, ou terms não aceito
403Usuário não tem permissão para criar organizações

​
Exemplo

curl -X POST "https://api.chargefy.io/api/v1/organizations/" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Minha Empresa",
    "terms": true,
    "bio": "Empresa de tecnologia",
    "email": "contato@minhaempresa.com.br",
    "website": "https://minhaempresa.com.br"
  }'

​
Resposta de Exemplo

{
  "id": "org_abc123",
  "name": "Minha Empresa",
  "avatar_url": null,
  "bio": "Empresa de tecnologia",
  "email": "contato@minhaempresa.com.br",
  "website": "https://minhaempresa.com.br",
  "status": "created",
  "next_review_threshold": 0,
  "customer_invoice_prefix": "MINHA-EMPRESA",
  "customer_invoice_next_number": 1,
  "profile_settings": {},
  "feature_settings": {},
  "subscription_settings": {
    "allow_multiple_subscriptions": false,
    "allow_customer_updates": true,
    "proration_behavior": "prorate"
  },
  "notification_settings": {
    "new_sale": true,
    "new_subscription": true
  },
  "socials": [],
  "details": {},
  "created_at": "2026-03-23T10:00:00Z",
  "modified_at": null
}