Clientes e acessos
Clientes, suas contas de cobrança, os usuários que entram no portal e o time que usa o dashboard da organização.
Famílias nesta página
| Família | Tools | read | write | destructive |
|---|---|---|---|---|
customers — Clientes e contas de cobrança | 19 | 6 | 9 | 4 |
portal-users — Usuários do portal | 9 | 4 | 4 | 1 |
users — Usuários do dashboard | 6 | 2 | 3 | 1 |
roles — Papéis do time | 6 | 2 | 3 | 1 |
customers
| Tool | Tipo | Permissão | Endpoint | O que faz |
|---|---|---|---|---|
billing_customers_list | read | customers.list | GET /v1/customers | List the customers of the token organization. |
billing_customers_get | read | customers.show | GET /v1/customers/:id | Fetch one customer by id, public_id or external_id. |
billing_customers_create | write | customers.create | POST /v1/customers | Create a customer and, unless create_billing_account is false, the billing account that bills it. |
billing_customers_upsert | write | customers.create | PUT /v1/customers | Create or update a customer, matched on id → public_id → external_id → document_number, stopping at the first hit. |
billing_customers_update | write | customers.update | PATCH /v1/customers/:id | Update a customer in place. |
billing_customers_delete | destructive | customers.delete | DELETE /v1/customers/:id | Soft-delete a customer (deleted_at). |
billing_customers_recalculate_mrr | write | customers.update | POST /v1/customers/:id/recalculate-mrr | Recompute the customer MRR from its active subscriptions. |
billing_customers_statement | read | customers.show | GET /v1/customers/:id/statement | Account statement for a customer: invoices, payments, credits and the running balance. |
billing_customers_statement_sync | write | customers.update | POST /v1/customers/:id/statement/sync | Recompute and persist the customer statement snapshot. |
billing_billing_accounts_list | read | customers.list | GET /v1/billing_accounts | List billing accounts. |
billing_billing_accounts_get | read | customers.show | GET /v1/billing_accounts/:id | Fetch one billing account by id, public_id or external_id. |
billing_billing_accounts_create | write | customers.create | POST /v1/billing_accounts | Open a billing account for an existing customer. |
billing_billing_accounts_upsert | write | customers.create | PUT /v1/billing_accounts | Create or update a billing account matched on id → public_id → external_id. |
billing_billing_accounts_update | write | customers.update | PATCH /v1/billing_accounts/:id | Update a billing account in place. |
billing_billing_accounts_delete | destructive | customers.delete | DELETE /v1/billing_accounts/:id | Soft-delete a billing account. |
billing_billing_accounts_suspend | destructive | customers.suspend | POST /v1/billing_accounts/:id/suspend | Suspend a billing account. |
billing_billing_accounts_reactivate | write | customers.reactivate | POST /v1/billing_accounts/:id/reactivate | Lift a suspension and resume collection on a billing account. |
billing_billing_accounts_close | destructive | customers.delete | POST /v1/billing_accounts/:id/close | Close a billing account for good. |
billing_billing_accounts_entitlements | read | customers.show | GET /v1/billing_accounts/:id/entitlements | What this billing account is entitled to right now, derived from its active subscriptions — the answer to "can this customer use feature X?". |
portal-users
| Tool | Tipo | Permissão | Endpoint | O que faz |
|---|---|---|---|---|
billing_customer_users_list | read | portal-users.list | GET /v1/customers/:id/users | List the portal users attached to a customer. |
billing_customer_users_create | write | portal-users.create | POST /v1/customers/:id/users | Attach a portal user to a customer without sending an invitation e-mail. |
billing_customer_users_invite | write | portal-users.create | POST /v1/customers/:id/users/invite | Invite a portal user to a customer — creates the user and sends the invitation e-mail. |
billing_customer_users_get | read | portal-users.show | GET /v1/customers/:id/users/:user_id | Fetch one portal user of a customer. |
billing_customer_users_update | write | portal-users.update | PATCH /v1/customers/:id/users/:user_id | Update a portal user of a customer (name, role, status). |
billing_customer_users_delete | destructive | portal-users.delete | DELETE /v1/customers/:id/users/:user_id | Detach a portal user from a customer. |
billing_customer_users_resend_invite | write | portal-users.update | POST /v1/customers/:id/users/:user_id/resend | Re-send the portal invitation e-mail to a customer user. |
billing_customer_users_email_preview | read | portal-users.show | GET /v1/customers/:id/users/:user_id/email-preview | Render the invitation e-mail for a customer user without sending it — subject and HTML, as the recipient would see it. |
billing_portal_users_list | read | portal-users.list | GET /v1/portal_users | List every portal user of the organization, across customers. |
users
| Tool | Tipo | Permissão | Endpoint | O que faz |
|---|---|---|---|---|
billing_dashboard_users_list | read | users.list | GET /v1/dashboard_users | List the dashboard (team) users of the organization. |
billing_dashboard_users_get | read | users.show | GET /v1/dashboard_users/:id | Fetch one dashboard user with the roles they hold. |
billing_dashboard_users_create | write | users.create | POST /v1/dashboard_users | Add a dashboard user to the organization and assign a role. |
billing_dashboard_users_upsert | write | users.create | PUT /v1/dashboard_users | Create or update a dashboard user matched on id → external_id → email. |
billing_dashboard_users_update | write | users.update | PATCH /v1/dashboard_users/:id | Update a dashboard user — name, role or status. |
billing_dashboard_users_delete | destructive | users.delete | DELETE /v1/dashboard_users/:id | Remove a dashboard user. |
roles
| Tool | Tipo | Permissão | Endpoint | O que faz |
|---|---|---|---|---|
billing_team_roles_list | read | roles.list | GET /v1/team_roles | List the roles a dashboard user can hold, with their permission sets. |
billing_team_roles_get | read | roles.show | GET /v1/team_roles/:id | Fetch one role with its permissions. |
billing_team_roles_create | write | roles.create | POST /v1/team_roles | Create a custom role with an explicit permission list. |
billing_team_roles_upsert | write | roles.create | PUT /v1/team_roles | Create or update a role matched on id → external_id → slug. |
billing_team_roles_update | write | roles.update | PATCH /v1/team_roles/:id | Update a custom role. |
billing_team_roles_delete | destructive | roles.delete | DELETE /v1/team_roles/:id | Delete a custom role. |
Os campos de cada recurso estão na Referência da API e em billing_schemas_get.
Uma tool que você não pode rodar não aparece em tools/list. Se uma daqui não está lá, veja Autenticação.