> ## Documentation Index
> Fetch the complete documentation index at: https://developers.datafyapi.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Assinar canal

> Ativa a assinatura do canal. A cobrança proporcional aos dias restantes do ciclo é feita na hora.

## Como funciona a cobrança

A conta tem uma assinatura, e o valor cobrado acompanha a quantidade de canais ativos. Assinar um canal aumenta essa quantidade em um.

* A cobrança proporcional aos dias restantes do ciclo é feita no momento da chamada.
* Se o cartão for recusado, o canal não é ativado e a resposta é `402`.
* Assinar um canal que já está ativo não altera nada e devolve a mesma resposta.

> [!NOTE]
>
> A primeira assinatura da conta e o encerramento dela são feitos no [painel da Datafy](https://app.datafyapi.com.br). Pela API é possível assinar e cancelar canais enquanto a conta tiver uma assinatura ativa.

## Resposta

| Campo | Descrição |
| - | - |
| `id` | ID do canal |
| `subscribed` | Situação da assinatura do canal |


## OpenAPI

````yaml api-reference/administracao/specs/canais.json POST /channels/whatsapp/{id}/subscribe
openapi: 3.1.0
info:
  title: Datafy API — Administração de canais
  version: 1.0.0
servers:
  - url: https://cloud.datafyapi.com.br
    description: Produção
security:
  - tokenDeConta: []
paths:
  /channels/whatsapp/{id}/subscribe:
    post:
      summary: Assinar canal
      description: >-
        Ativa a assinatura do canal. A cobrança proporcional aos dias restantes
        do ciclo é feita na hora.
      operationId: assinarCanal
      parameters:
        - $ref: '#/components/parameters/CanalId'
      responses:
        '200':
          description: Situação da assinatura do canal.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: ID do canal.
                  subscribed:
                    type: boolean
                    description: Situação da assinatura do canal.
              example:
                id: 96c3df7e-300c-47de-bfaf-7d2a2899bd19
                subscribed: true
        '401':
          $ref: '#/components/responses/NaoAutorizado'
        '402':
          description: Pagamento recusado.
          content:
            application/json:
              example:
                statusCode: 402
                message: Pagamento recusado. Verifique o cartão e tente novamente.
        '403':
          $ref: '#/components/responses/AssinaturaInativa'
        '404':
          $ref: '#/components/responses/CanalNaoEncontrado'
        '409':
          description: A assinatura da conta não permite assinar canais.
          content:
            application/json:
              examples:
                agendada_para_cancelar:
                  summary: Assinatura agendada para cancelamento
                  value:
                    statusCode: 409
                    message: >-
                      Sua assinatura está agendada para cancelamento. Reative
                      pelo painel antes de assinar novos canais.
                sem_assinatura:
                  summary: Conta sem assinatura
                  value:
                    statusCode: 409
                    message: >-
                      Você ainda não tem uma assinatura. Crie a primeira
                      assinatura pelo painel.
components:
  parameters:
    CanalId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: ID do canal, retornado em Listar canais e em Criar canal.
  responses:
    NaoAutorizado:
      description: Token de conta ausente ou inválido.
      content:
        application/json:
          example:
            statusCode: 401
            message: Token de conta ausente ou inválido
    AssinaturaInativa:
      description: A assinatura da conta não está ativa.
      content:
        application/json:
          example:
            statusCode: 403
            message: >-
              Sua assinatura precisa estar ativa para usar a API. Acesse o
              painel para ativá-la.
    CanalNaoEncontrado:
      description: Canal inexistente ou de outra conta.
      content:
        application/json:
          example:
            statusCode: 404
            message: Canal não encontrado
  securitySchemes:
    tokenDeConta:
      type: http
      scheme: bearer
      description: >-
        Token de conta gerado no painel da Datafy, em Perfil. Formato:
        `sk_acct_xxx`. Diferente do token de canal (`sk_live_`).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.