Gerenciar assinatura das lojas

Cada ação é uma chamada em /partner/v2/merchants/{merchantId}/<ação>. As de estado respondem 202 Accepted com o ID da loja; a atualização responde 200 OK.

Ação	Endpoint	Exige status	Efeito
Ativar	`POST activate`	`TRIAL`, `TRIAL_EXPIRED` ou `CANCELLED`	Vai para `ACTIVATED`.
Cancelar	`POST cancel`	`ACTIVATED`	Vai para `CANCELLED`.
Ativar aviso	`POST warning`	`ACTIVATED`	`warning: true`, `blocked: false`.
Desativar aviso	`POST unwarning`	`ACTIVATED`	`warning: false`.
Bloquear	`POST block`	`ACTIVATED`	`blocked: true`, `warning: false`.
Desbloquear	`POST unblock`	`ACTIVATED`	`blocked: false`.
Atualizar	`PUT subscription`	`TRIAL`, `ACTIVATED` ou `DEMO`	Troca `agreementCode` e/ou plano.

Resposta (202)

{ "merchantId": "d7240afd-d47c-4ae8-b79d-f14d3e8e1dd8" }

Quando o status não aceita a ação, a resposta é 422 com o motivo no title, por exemplo {"status": "422", "title": "Subscription must be activated"}. Loja fora do alcance do token retorna 404.

Ativar Assinatura

Tira a loja do teste ou reativa uma loja cancelada.

string

Código do contrato. Omita (ou envie null) para manter o atual.

uuid

Plano de cobrança. Omita para manter o atual. Precisa ser um plano AVAILABLE do parceiro, com visibilidade compatível com a loja: PUBLIC ou DIRECT_MERCHANT para lojas diretas, PUBLIC ou RESALE para lojas de revenda. Veja Planos.

curl --request POST 'https://api.deliveryvip.com.br/partner/v2/merchants/{merchantId}/activate' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "subscription": {
      "agreementCode": "123456",
      "planId": "47f3af9c-c380-4e09-8f73-76bc06634d76"
    }
  }'

await fetch(`https://api.deliveryvip.com.br/partner/v2/merchants/${merchantId}/activate`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ subscription: { agreementCode: '123456', planId } }),
})

requests.post(
    f"https://api.deliveryvip.com.br/partner/v2/merchants/{merchant_id}/activate",
    headers={"Authorization": f"Bearer {token}"},
    json={"subscription": {"agreementCode": "123456", "planId": plan_id}},
)

A ativação é recusada com 422 quando:

a loja é DEMO (Subscription is demo);
a assinatura do parceiro ou da revenda da loja não está ACTIVATED (Partner subscription is not activated);
o planId não existe, não está disponível ou não é visível para a loja (Invalid plan);
a loja já está ACTIVATED.

Reativação no mesmo mês do cancelamento. Se a loja foi cancelada no mês corrente (ou há menos de 24 horas), a reativação muda o status, mas mantém lastActivationAt e ignora agreementCode e planId. Envie-os em seguida com Atualizar Assinatura.

Cancelar Assinatura

Encerra a assinatura. Não tem corpo.

curl --request POST 'https://api.deliveryvip.com.br/partner/v2/merchants/{merchantId}/cancel' \
  --header 'Authorization: Bearer {token}'

O cancelamento também cancela todos os recursos contratados e remove os domínios da loja. Ao reativar, o domínio padrão é recriado, mas domínios personalizados precisam ser configurados de novo.

Ativar Aviso

Sinaliza que a loja pode ser bloqueada em breve, por exemplo por atraso de pagamento. Não tem corpo. Desliga um bloqueio ativo.

curl --request POST 'https://api.deliveryvip.com.br/partner/v2/merchants/{merchantId}/warning' \
  --header 'Authorization: Bearer {token}'

Desativar Aviso

Remove o aviso. Não tem corpo: POST /partner/v2/merchants/{merchantId}/unwarning.

Bloquear Assinatura

Bloqueia o uso da loja. Não tem corpo: POST /partner/v2/merchants/{merchantId}/block.

O bloqueio não cancela: a assinatura continua ACTIVATED e continua sendo cobrada. Use o bloqueio para inadimplência, não como cancelamento.

Desbloquear Assinatura

Libera a loja. Não tem corpo: POST /partner/v2/merchants/{merchantId}/unblock.

Atualizar Assinatura

Troca o código do contrato, o plano ou os dois, sem mudar o status. Aceita lojas em TRIAL, ACTIVATED ou DEMO; nos demais status responde 422 (Failed to update subscription).

string

Código do contrato. Omita (ou envie null) para manter; envie "" para apagar.

uuid

Novo plano. Mesmas regras de visibilidade da ativação. Plano inválido retorna 422.

curl --request PUT 'https://api.deliveryvip.com.br/partner/v2/merchants/{merchantId}/subscription' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "subscription": {
      "agreementCode": "123456",
      "planId": "47f3af9c-c380-4e09-8f73-76bc06634d76"
    }
  }'

await fetch(`https://api.deliveryvip.com.br/partner/v2/merchants/${merchantId}/subscription`, {
  method: 'PUT',
  headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ subscription: { agreementCode: '123456', planId } }),
})

requests.put(
    f"https://api.deliveryvip.com.br/partner/v2/merchants/{merchant_id}/subscription",
    headers={"Authorization": f"Bearer {token}"},
    json={"subscription": {"agreementCode": "123456", "planId": plan_id}},
)

Resposta (200)

{ "merchantId": "d7240afd-d47c-4ae8-b79d-f14d3e8e1dd8" }

Ao trocar de plano, os recursos da loja são sincronizados com o novo plano.

Código do Contrato

PUT /partner/v2/merchants/{merchantId}/agreementCode está descontinuado em favor de Atualizar Assinatura. A data de desligamento anunciada foi 01/07/2025; a rota ainda responde, com os headers Deprecation: true e Sunset: Tue, 01 Jul 2025 00:00:00 GMT, e pode ser removida a qualquer momento.

Aceita o mesmo corpo de PUT subscription e responde igual. Migre trocando apenas o final do caminho.

Visão geral

Lojas

Revendas

Planos

Faturas

Cadastro

Referência

Ativar Assinatura

Cancelar Assinatura

Ativar Aviso

Desativar Aviso

Bloquear Assinatura

Desbloquear Assinatura

Atualizar Assinatura

Código do Contrato

​Ativar Assinatura

​Cancelar Assinatura

​Ativar Aviso

​Desativar Aviso

​Bloquear Assinatura

​Desbloquear Assinatura

​Atualizar Assinatura

​Código do Contrato

Ativar Assinatura

Cancelar Assinatura

Ativar Aviso

Desativar Aviso

Bloquear Assinatura

Desbloquear Assinatura

Atualizar Assinatura

Código do Contrato