Interrompe futuras cobranças da própria assinatura e mantém o período pago.

Exige venda mensal ativa ou homologação habilitada e pagamento de teste autorizado pelo servidor. Sem essa autorização, responde 404. Envie somente {} com JSON até 4 KiB, sessão válida, origem e CSRF. Grava o pedido antes de chamar o Asaas. Cancelamento pendente não equivale a cancelamento confirmado. Pode repetir o mesmo pedido. Reembolso tem tratamento próprio; este pedido não estorna o pagamento. Returns: { recurso, id, oferta_id, oferta{id,produto,versao,preco_centavos,moeda,ciclo,renovacao_automatica,compromisso_meses,cancelamento,acesso_pago,teste_dias,conversao_teste,beneficios,hash}, estado, simulado, pagamento_em, criado_em, atualizado_em, cancelamento_em, cancelado_em }

post/api/credito/assinaturas/{id}

Request

  • Base URL: https://okfindex.com
  • URL: https://okfindex.com/api/credito/assinaturas/{id}
  • Auth: none declared. Required headers: Origin, X-CSRF-Token

Path parameters

idstring required

ID local da assinatura: 32 caracteres hexadecimais minúsculos.

Query parameters

devstring

Bilhete de homologação assinado e vigente. Opcional; até 512 caracteres na query.

x402_devstring

Mesmo bilhete de dev. Use apenas um desses parâmetros por pedido.

recursostring

Recurso do produto: até 256 caracteres, sem controles. Filtra a assinatura da própria conta; vazio indica compra por conta.

Headers

X-X402-Devstring

Bilhete assinado e vigente da homologação. Sem ele, a flag do corpo não autoriza sandbox.

Originstring required

Origem HTTPS exata deste produto.

X-CSRF-Tokenstring required

Token de 64 caracteres do bootstrap da sessão deste produto. Protege contra pedidos de outro site.

Response

{ recurso, id, oferta_id, oferta{id,produto,versao,preco_centavos,moeda,ciclo,renovacao_automatica,compromisso_meses,cancelamento,acesso_pago,teste_dias,conversao_teste,beneficios,hash}, estado, simulado, pagamento_em, criado_em, atualizado_em, cancelamento_em, cancelado_em }

recursostring required

Recurso do produto: até 256 caracteres, sem controles. Filtra a assinatura da própria conta; vazio indica compra por conta.

idstring required

ID local de 32 caracteres hexadecimais; identifica a consulta e o cancelamento.

oferta_idstring required

ID da oferta aceita.

estadostring required

criando, inconclusiva, checkout, aguardando_pagamento, ativa, cancelando, cancelada, falhou ou expirada.

simuladoboolean required

Ambiente gravado pelo servidor: true para sandbox, false para produção.

pagamento_emstring nullable required

Null na contratação por API. Registros antigos podem ter link HTTPS Asaas no estado checkout.

criado_emstring required

Data e hora UTC da criação da assinatura.

atualizado_emstring required

Data e hora UTC da última alteração.

cancelamento_emstring nullable required

Data e hora UTC do pedido de cancelamento, ou null.

cancelado_emstring nullable required

Data e hora UTC do cancelamento confirmado, ou null.

Changes

No recorded changes to this operation across all 1 revision of this API.