Guia de Assinaturas

Confira o guia de assinaturas para mais informações.

Endpoint responsável por recuperar a configuração de emissão automática de notas fiscais vinculada a uma assinatura.

Esse recurso permite consultar todas as regras fiscais atualmente configuradas para a recorrência, como momento da emissão, serviço municipal, impostos e demais parâmetros utilizados automaticamente na geração das notas fiscais.

A consulta não altera nenhuma configuração da assinatura.

Quando utilizar

Utilize este endpoint quando sua integração precisar:

• consultar a configuração fiscal de uma assinatura;
• validar se a emissão automática de notas fiscais está habilitada;
• recuperar as regras utilizadas para emissão das próximas notas fiscais;
• sincronizar configurações fiscais com sistemas externos;
• verificar as configurações antes de realizar uma atualização.

Caso seja necessário alterar essas informações, utilize o endpoint Atualizar configuração para emissão de Notas Fiscais.

Parâmetro importante

Este endpoint possui apenas um parâmetro obrigatório:

• id — identificador único da assinatura no Asaas.

Como funciona

Após localizar a assinatura informada, o Asaas retorna toda a configuração de emissão automática atualmente associada à recorrência.

Fluxo simplificado:

Assinatura
        ↓
Consultar configuração
        ↓
Receber regras fiscais configuradas

Caso nenhuma configuração exista para a assinatura, a API retornará o comportamento correspondente ao recurso inexistente.

Comportamentos importantes

Ao utilizar este endpoint, considere que:

• a consulta não altera nenhuma configuração existente;
• apenas configurações pertencentes à conta autenticada poderão ser consultadas;
• os dados retornados serão utilizados automaticamente nas próximas emissões de notas fiscais da assinatura;
• alterações futuras somente ocorrerão após utilização do endpoint de atualização.

Exemplos de uso

Consultar a configuração de emissão automática:

GET /v3/subscriptions/{id}/invoiceSettings

Consultar antes de atualizar a configuração:

Recuperar configuração
        ↓
Validar informações atuais
        ↓
Atualizar apenas os campos necessários

Boas práticas

Erros comuns

400 Bad Request

Pode ocorrer quando o identificador informado é inválido.

401 Unauthorized

Ocorre quando a API Key é inválida ou pertence ao ambiente incorreto.

403 Forbidden

Pode ocorrer quando uma requisição GET é enviada com body preenchido. Chamadas GET devem utilizar apenas parâmetros na URL.

404 Not Found

Ocorre quando a assinatura não existe, não pertence à conta autenticada ou ainda não possui configuração de emissão cadastrada.

Impactos operacionais

Consultar a configuração permite validar como as próximas notas fiscais serão emitidas antes que novas cobranças sejam geradas.

Essa verificação é recomendada principalmente em integrações que realizam alterações automáticas de parâmetros fiscais, reduzindo inconsistências entre o Asaas e sistemas externos.

Conteúdos relacionados

• Criar configuração para emissão de Notas Fiscais
• Atualizar configuração para emissão de Notas Fiscais
• Remover configuração para emissão de Notas Fiscais
• Listar notas fiscais das cobranças de uma assinatura
• Guia de Assinaturas