Skip to main content
POST
Esta rota anexa uma imagem ao plano, como o logotipo do produto ou uma arte da oferta. Depois do envio, o endereço da imagem passa a aparecer no campo imageUrl do plano, pronto para ser exibido na sua vitrine de planos.

Quando usar

Antes de chamar

  • Tenha uma chave secreta gerada por usuário com a permissão atualizar assinaturas. Nos perfis padrão, são Owner, Manager e Operador. Os perfis Visualizador, Desenvolvedor e Financeiro recebem 403 (veja Permissões por perfil).
  • Tenha o id do plano.
  • Tenha o arquivo em PNG, JPG ou JPEG.
Assinaturas não têm modo de teste: as cobranças são reais mesmo com a chave de teste. Veja como homologar em Assinaturas: visão geral.
Para o desenvolvedor: esta é uma das poucas rotas de assinatura que não recebem JSON. O corpo vai como multipart/form-data, com o arquivo no campo file. Não defina o header Content-Type manualmente ao usar FormData no Node.js ou a opção -F do cURL: a biblioteca monta o header com o boundary correto.

Parâmetros de caminho

string
required
Identificador único do plano. Ex.: 2RhQg9M7ZCg3X3nMb9W1kX8Q.

Corpo da requisição

Formato multipart/form-data. Campo obrigatório: file.
file
required
Arquivo de imagem (formato binary): PNG, JPG ou JPEG.

Respostas

A resposta de sucesso não tem corpo. Para obter a URL da imagem, consulte o plano e leia o campo imageUrl.
Para o negócio: a imagem é um dado do plano, guardado junto com nome, preço e mensagem ao comprador. A forma de exibi-la (tamanho, recorte, onde aparece) fica a cargo da sua aplicação, que lê o imageUrl.

Erros comuns

Veja também

Planos

Recorrência, trial e status do plano.

Visão geral de assinaturas

Fluxo completo, do cliente à cobrança recorrente.

Ciclo de vida

Status, renovação, retentativas e cancelamento.

Webhooks de assinatura

Eventos enviados a cada etapa da assinatura.

Registrar cartão

Guarde o cartão no cofre antes de criar a assinatura.

Consultar plano

Leia o imageUrl atualizado.