Pular para o conteúdo

Reativar uma assinatura pausada

PUThttps://api.sandbox.cefispay.com.br/api/v1/subscription/unpause

Reativa uma assinatura paused: ela volta a active. Nos outros status, a API responde 400 INVALID_STATE_ERROR. Detalhes no guia de assinaturas.

Parâmetros do body

obrigatórioapplication/json
  • subscriptionobjectobrigatório
    subscription object
    • idintegerobrigatório

      O id da assinatura.

Respostas

201Assinatura reativada com sucesso

Corpo da resposta

application/json

Exemplo

{
  "subscription": {
    "id": "string",
    "uuid": "string",
    "plan_id": "string",
    "plan": {},
    "customer_id": "string",
    "customer": {},
    "method": "string",
    "card_id": "string",
    "credit_card": {},
    "amount": 0,
    "value": 0,
    "last_card_digits": "string",
    "products": [
      "string"
    ],
    "histories": [
      "string"
    ],
    "coupons": [
      "string"
    ],
    "status": "new",
    "reason_cancel": "string",
    "cancel_type": "string",
    "voluntary_cancel": true,
    "start": "2024-01-01",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "end": "2024-01-01",
    "next_payment": "2024-01-01T00:00:00Z",
    "retries": 0,
    "custom_data": {},
    "company": {},
    "charge_enabled": true,
    "customerContract": {}
  }
}
400O recurso não está num estado que permita a ação

Corpo da resposta

application/json

  • codestring

    O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.

  • messagestring

    A mensagem do erro.

  • errorsobject

    Os erros de cada campo, quando o code é VALIDATION_ERROR.

  • timestampstringdate-time

    A data e hora do erro, em UTC.

  • request_idstring

    Um identificador único gerado para esta resposta de erro.

  • documentation_urlstring

    O endereço desta documentação.

  • suggestionstring

    Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "INVALID_STATE_ERROR",
  "message": "This payment is already paid and cannot be cancelled.",
  "timestamp": "2026-10-22T12:10:02+00:00",
  "request_id": "3e1f0c52-8a4b-4d6e-9f21-7c5b6a4d3e2f",
  "documentation_url": "https://docs.ninepay.com.br"
}
401Não autenticado

Corpo da resposta

application/json

  • codestring

    O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.

  • messagestring

    A mensagem do erro.

  • errorsobject

    Os erros de cada campo, quando o code é VALIDATION_ERROR.

  • timestampstringdate-time

    A data e hora do erro, em UTC.

  • request_idstring

    Um identificador único gerado para esta resposta de erro.

  • documentation_urlstring

    O endereço desta documentação.

  • suggestionstring

    Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "AUTHENTICATION_ERROR",
  "message": "Não autenticado.",
  "timestamp": "2026-10-22T12:03:44+00:00",
  "request_id": "f2a7e962-6083-4525-816e-f14d4a602e0a",
  "documentation_url": "https://docs.ninepay.com.br"
}
403O recurso não é da sua empresa (em várias rotas, também um id que não existe)

Corpo da resposta

application/json

  • codestring

    O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.

  • messagestring

    A mensagem do erro.

  • errorsobject

    Os erros de cada campo, quando o code é VALIDATION_ERROR.

  • timestampstringdate-time

    A data e hora do erro, em UTC.

  • request_idstring

    Um identificador único gerado para esta resposta de erro.

  • documentation_urlstring

    O endereço desta documentação.

  • suggestionstring

    Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "FORBIDDEN_ERROR",
  "message": "Você não possui permissão para executar esta ação.",
  "timestamp": "2026-10-22T12:22:43+00:00",
  "request_id": "0b6b1d9c-5a3e-4f7e-9d0a-1c2b3d4e5f60",
  "documentation_url": "https://docs.ninepay.com.br"
}
422Erro na validação dos dados

Corpo da resposta

application/json

  • codestring

    O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.

  • messagestring

    A mensagem do erro.

  • errorsobject

    Os erros de cada campo, quando o code é VALIDATION_ERROR.

  • timestampstringdate-time

    A data e hora do erro, em UTC.

  • request_idstring

    Um identificador único gerado para esta resposta de erro.

  • documentation_urlstring

    O endereço desta documentação.

  • suggestionstring

    Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "VALIDATION_ERROR",
  "message": "Os dados informados são inválidos.",
  "errors": {
    "email": [
      "O campo email é obrigatório."
    ]
  },
  "timestamp": "2026-10-22T12:03:54+00:00",
  "request_id": "64d62d36-e797-45ed-a9d5-c203bde81032",
  "documentation_url": "https://docs.ninepay.com.br",
  "suggestion": "Corrija os campos e tente novamente."
}
500Erro inesperado

Corpo da resposta

application/json

  • codestring

    O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.

  • messagestring

    A mensagem do erro.

  • errorsobject

    Os erros de cada campo, quando o code é VALIDATION_ERROR.

  • timestampstringdate-time

    A data e hora do erro, em UTC.

  • request_idstring

    Um identificador único gerado para esta resposta de erro.

  • documentation_urlstring

    O endereço desta documentação.

  • suggestionstring

    Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "UNEXPECTED_ERROR",
  "message": "Houve um erro inesperado.",
  "timestamp": "2026-10-22T12:04:46+00:00",
  "request_id": "868443d3-38fd-4c92-8ea8-7cccbbce4308",
  "documentation_url": "https://docs.ninepay.com.br",
  "suggestion": "Verifique todos os parâmetros da requisição. Se o erro persistir, entre em contato com nossa equipe em ti@ninepay.com.br."
}

Linguagem

Credenciais

Header
Header
curl --request PUT \
     --url https://api.sandbox.cefispay.com.br/api/v1/subscription/unpause \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui

Ou escolha um exemplo:

application/json