Pular para o conteúdo principal

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íliaToolsreadwritedestructive
customers — Clientes e contas de cobrança19694
portal-users — Usuários do portal9441
users — Usuários do dashboard6231
roles — Papéis do time6231

customers​

ToolTipoPermissãoEndpointO que faz
billing_customers_listreadcustomers.listGET /v1/customersList the customers of the token organization.
billing_customers_getreadcustomers.showGET /v1/customers/:idFetch one customer by id, public_id or external_id.
billing_customers_createwritecustomers.createPOST /v1/customersCreate a customer and, unless create_billing_account is false, the billing account that bills it.
billing_customers_upsertwritecustomers.createPUT /v1/customersCreate or update a customer, matched on id → public_id → external_id → document_number, stopping at the first hit.
billing_customers_updatewritecustomers.updatePATCH /v1/customers/:idUpdate a customer in place.
billing_customers_deletedestructivecustomers.deleteDELETE /v1/customers/:idSoft-delete a customer (deleted_at).
billing_customers_recalculate_mrrwritecustomers.updatePOST /v1/customers/:id/recalculate-mrrRecompute the customer MRR from its active subscriptions.
billing_customers_statementreadcustomers.showGET /v1/customers/:id/statementAccount statement for a customer: invoices, payments, credits and the running balance.
billing_customers_statement_syncwritecustomers.updatePOST /v1/customers/:id/statement/syncRecompute and persist the customer statement snapshot.
billing_billing_accounts_listreadcustomers.listGET /v1/billing_accountsList billing accounts.
billing_billing_accounts_getreadcustomers.showGET /v1/billing_accounts/:idFetch one billing account by id, public_id or external_id.
billing_billing_accounts_createwritecustomers.createPOST /v1/billing_accountsOpen a billing account for an existing customer.
billing_billing_accounts_upsertwritecustomers.createPUT /v1/billing_accountsCreate or update a billing account matched on id → public_id → external_id.
billing_billing_accounts_updatewritecustomers.updatePATCH /v1/billing_accounts/:idUpdate a billing account in place.
billing_billing_accounts_deletedestructivecustomers.deleteDELETE /v1/billing_accounts/:idSoft-delete a billing account.
billing_billing_accounts_suspenddestructivecustomers.suspendPOST /v1/billing_accounts/:id/suspendSuspend a billing account.
billing_billing_accounts_reactivatewritecustomers.reactivatePOST /v1/billing_accounts/:id/reactivateLift a suspension and resume collection on a billing account.
billing_billing_accounts_closedestructivecustomers.deletePOST /v1/billing_accounts/:id/closeClose a billing account for good.
billing_billing_accounts_entitlementsreadcustomers.showGET /v1/billing_accounts/:id/entitlementsWhat this billing account is entitled to right now, derived from its active subscriptions — the answer to "can this customer use feature X?".

portal-users​

ToolTipoPermissãoEndpointO que faz
billing_customer_users_listreadportal-users.listGET /v1/customers/:id/usersList the portal users attached to a customer.
billing_customer_users_createwriteportal-users.createPOST /v1/customers/:id/usersAttach a portal user to a customer without sending an invitation e-mail.
billing_customer_users_invitewriteportal-users.createPOST /v1/customers/:id/users/inviteInvite a portal user to a customer — creates the user and sends the invitation e-mail.
billing_customer_users_getreadportal-users.showGET /v1/customers/:id/users/:user_idFetch one portal user of a customer.
billing_customer_users_updatewriteportal-users.updatePATCH /v1/customers/:id/users/:user_idUpdate a portal user of a customer (name, role, status).
billing_customer_users_deletedestructiveportal-users.deleteDELETE /v1/customers/:id/users/:user_idDetach a portal user from a customer.
billing_customer_users_resend_invitewriteportal-users.updatePOST /v1/customers/:id/users/:user_id/resendRe-send the portal invitation e-mail to a customer user.
billing_customer_users_email_previewreadportal-users.showGET /v1/customers/:id/users/:user_id/email-previewRender the invitation e-mail for a customer user without sending it — subject and HTML, as the recipient would see it.
billing_portal_users_listreadportal-users.listGET /v1/portal_usersList every portal user of the organization, across customers.

users​

ToolTipoPermissãoEndpointO que faz
billing_dashboard_users_listreadusers.listGET /v1/dashboard_usersList the dashboard (team) users of the organization.
billing_dashboard_users_getreadusers.showGET /v1/dashboard_users/:idFetch one dashboard user with the roles they hold.
billing_dashboard_users_createwriteusers.createPOST /v1/dashboard_usersAdd a dashboard user to the organization and assign a role.
billing_dashboard_users_upsertwriteusers.createPUT /v1/dashboard_usersCreate or update a dashboard user matched on id → external_id → email.
billing_dashboard_users_updatewriteusers.updatePATCH /v1/dashboard_users/:idUpdate a dashboard user — name, role or status.
billing_dashboard_users_deletedestructiveusers.deleteDELETE /v1/dashboard_users/:idRemove a dashboard user.

roles​

ToolTipoPermissãoEndpointO que faz
billing_team_roles_listreadroles.listGET /v1/team_rolesList the roles a dashboard user can hold, with their permission sets.
billing_team_roles_getreadroles.showGET /v1/team_roles/:idFetch one role with its permissions.
billing_team_roles_createwriteroles.createPOST /v1/team_rolesCreate a custom role with an explicit permission list.
billing_team_roles_upsertwriteroles.createPUT /v1/team_rolesCreate or update a role matched on id → external_id → slug.
billing_team_roles_updatewriteroles.updatePATCH /v1/team_roles/:idUpdate a custom role.
billing_team_roles_deletedestructiveroles.deleteDELETE /v1/team_roles/:idDelete 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.