Histórico de mensagens em assinaturas

Você pode usar o endpoint GET /v1/plans para retornar todos os planos
https://dev.efipay.com.br/docs/api-cobrancas/assinatura/#retornar-informa%C3%A7%C3%B5es-de-um-plano

vou olhar aqui, o planos que são associados a cada assinatura fica registrado em algum lugar no painel do efí ?

@gabrielcarvalho_27631, certifique se ao criar a assinatura você passou o id do plano correto.
Acabei de fazer um teste, e foi exibido corretamente conforme o plano que criei.

por que mesmo eu definindo assim:
{
'name' => $plan['name'] . ' da Memprega.com.br',
'interval' => 12,
'repeats' => null
}
ao acessar o painel e verificar as assinaturas o mesmo sai igual na imagem

@gabrielcarvalho_27631, na criação do plano você irá definir o nome do plano, intervalo e quantidade de repetições. O valor é definido na criação da assinatura.
Então para criar um plano com a regra mencionada, você irá definir interval=12 e repeats a quantidade de vezes que deseja cobrar essa anuidade, se deixar repeats=null as cobranças serão geradas por tempo indeterminado ou até que a assinatura seja cancelada.

Exemplo:

@guilherme_efi @joaolucas_efi como faço para configurar um plano que cobra uma vez ao ano
estou fazendo assim está correto?
'YEARLY_BUSINESS' => [
'price' => 100.00,
'name' => 'Plano Anual',
'interval' => 12,
],

seria no boleto

Ok muito obrigado, pela ajuda

Sim, assim você cancela a assinatura e evita futuras cobranças para seu cliente.

certo então se eu usar o PUT /v1/subscription/:id/cancel. já resolve no meu caso, certo?

No caso em que respondi, usando o endpoint PUT /v1/charge/:id/cancel não cancela as cobranças que já foram emitidas anteriormente. Mas tendo cancelado a assinatura por este endpoint, não serão geradas novas cobranças, conforme o João mencionou.

fique em dúvida agora qual o correto @joaolucas_efi ?

O @guilherme_efi me respondeu o seguinte:

Bom dia, @gabrielcarvalho_27631! Espero que esteja tudo bem com você.
Se você cancelar a assinatura, as cobranças dela não serão canceladas automaticamente.
Você precisaria usar o endpoint PUT /v1/charge/:id/cancel para cancelar cada cobrança individualmente, substituindo o :id pelo charge_id da cobrança de cartão ou boleto que você quer cancelar.

o meu sistema eu já uso o PUT /v1/subscription/:id/cancel. para cancelar a assinatura então não preciso realizar a utilização de mais nenhum endpoint com relação ao cancelamento das cobranças ?

Esse endpoint que enviei irá fazer justamente isso, ele canela a assinatura em si, não serão geradas mais cobranças recorrentes referentes à essa assinatura.

eu gostaria de cancelar a assinatura e todas as cobranças futuras do cliente, quais endpoints eu tenho que usar para isso?

Para cancelar uma assinatura você deve o usar o endpoint PUT /v1/subscription/:id/cancel.

Certo, mas no caso seu precisar cancelar o restante das parcelas que ainda não foram geradas, eu utilizo esse endpoint PUT /v1/charge/:id/cancel ? isso irá cancelar as outras parcelas ou eu preciso aguardar elas serem geradas para então somente efetuar o uso do endpoint PUT /v1/charge/:id/cancel ?

Na assinatura por cartão de crédito, a Efí irá cobrar mensalmente o valor definido no plano. Como mencionou, a primeira cobrança ocorrerá após os 15 dias de teste, e as demais serão feitas no dia do vencimento, até completar as 12 parcelas que você definiu no seu plano. Se o cliente não pagar a primeira parcela, ele continuará sendo cobrado nos meses seguintes normalmente.

@guilherme_efi entendi, no caso estou oferencendo ao meu cliente um periodo gratis de 15 dias usando o trial_day para cartão de crédito e o vencimento do boleto também para 15 dias, no caso do boleto o meu plano cobra uma 1 valor à vista e no cartão 12 vezes, se o cliente não efetuar o pagamento da primeira.
o Efí já cobra as 12 no cartão dele ou é cobrado mensalmente, e no caso dele não pagar a primeira no segundo mês ele será cobrado a 2ª das 12 vezes que comentei acima, poderia me explicar como funciona ?

Bom dia, @gabrielcarvalho_27631! Espero que esteja tudo bem com você.
Se você cancelar a assinatura, as cobranças dela não serão canceladas automaticamente.
Você precisaria usar o endpoint PUT /v1/charge/:id/cancel para cancelar cada cobrança individualmente, substituindo o :id pelo charge_id da cobrança de cartão ou boleto que você quer cancelar.

Bom dia, uma outra dúvida.
Se eu cancelar a assinatura de um cliente todas as cobranças referente a esse cliente também seram canceladas sendo elas cartão de credito ou boleto?