50c96157fff4

latestOpenAPI 3.1.02026-07-2678221359.6 KB
AutoRadar

Cancelar Assinatura

Cancela uma inscrição

Esta função cancela uma assinatura e não permite sua reativação

  • Funcionalidade síncrona, o retorno de sucesso ou erro é retornado imediatamente na requisição.
  • Quando uma assinatura é cancelada, ela não poderá ser mais reativada.
  • Esta funcionalidade é irreversível e não poderá ser desfeita.
  • Caso seja necessário inscrever novamente este veículo, deverá ser feita uma nova assinatura.
  • Apenas uma assinatura ativa poderá ser cancelada.
post/autoradar/{subscription_id}/cancel/

Path parameters

subscription_idstring required

Identificador da assinatura

Identificador da assinatura

Request body

reason'customer_canceled_plan' | 'customer_does_not_use_service' | 'customer_considered_expensive' | 'customer_does_not_have_car' | 'customer_does_not_understand_service' | 'customer_does_not_find_interesting' | 'service_does_not_met_expectations' | 'others'

Response

Assinatura cancelada com sucesso

idstring uuid required

Identificador da assinatura

store_idinteger nullable

Identificador do estabelecimento

created_atstring date-time required

Data e hora da criação da assinatura

updated_atstring date-time required

Data e hora da atualização da assinatura

is_activeboolean

Indica se a assinatura esta ativa

is_canceledboolean

Indica se a assinatura foi cancelada

external_idstring nullable

Identificador da assinatura no parceiro

channel'embedded' | 'offer' | 'application'
canceled_reasonstring nullable

Motivo de cancelamento

update_action_notification_sentboolean

Indica que o cliente foi notificado caso os requisitos mínimos não tenham sido atendidos

enqueuedboolean

Indica se a inscrição está em fila de processamento

last_enqueued_atstring date-time nullable

Data e hora da inscrição em fila de processamento