Atualizar assinatura existente

PUThttps://api.sandbox.cefispay.com.br/api/v1/subscriptions/{id}

Atualiza uma assinatura existente com base no ID fornecido. Nota: É necessário fornecer o ID da assinatura que deseja atualizar.

Parâmetros de path

idstringobrigatório

Parâmetros do body

obrigatórioapplication/json

Descreve os dados a serem incluídos no corpo da requisição.

customerobjectobrigatório
customer object
- idnumberobrigatório
  O ID do cliente na NinePay. Se você ainda não tem o ID do cliente, utilize o endpoint de criação de Cliente para fazer o cadastro e receber o ID.
planobjectobrigatório
plan object
- idnumberobrigatório
  O ID do plano a que a nova assinatura será vinculada.
coupon_codesarray de strings

Respostas

200Assinatura atualizada com sucesso

Corpo da resposta

application/json

idstring
O ID da assinatura.
uuidstring
O UUID da assinatura.
plan_idstring
O ID do plano da assinatura.
planobject
O plano da assinatura.
customer_idstring
O ID do cliente da assinatura.
customerobject
O cliente da assinatura.
methodstring
O método da assinatura.
card_idstring
O ID do cartão de crédito da assinatura.
credit_cardobject
O cartão de crédito da assinatura.
amountnumber
O valor recorrente da assinatura.
valuenumber
O valor da assinatura.
last_card_digitsstring
Os últimos dígitos do cartão da assinatura.
productsarray
Os produtos da assinatura.
historiesarray
O histórico da assinatura.
couponsarray
Os cupons da assinatura.
statusstring
Valores permitidos:newtrialactiveoverduecanceledexpiredpaused
reason_cancelstring
A razão do cancelamento da assinatura.
cancel_typestring
O tipo de cancelamento da assinatura.
voluntary_cancelboolean
O cancelamento voluntário da assinatura.
startstringdate
A data de início da assinatura.
created_atstringdate-time
A data e hora em que a assinatura foi criada.
updated_atstringdate-time
A data e hora em que a assinatura foi atualizada.
endstringdate
A data de término da assinatura.
next_paymentstringdate-time
A data e hora do próximo pagamento da assinatura.
retriesnumber
As tentativas da assinatura.
custom_dataobject
Os dados personalizados da assinatura.
companyobject
A empresa da assinatura.
charge_enabledboolean
A habilitação da cobrança da assinatura.
customerContractobject
O contrato do cliente da assinatura.

Exemplo

{
  "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": {}
}

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"
}

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."
}

Parâmetros de path

Parâmetros do body

Respostas

Credenciais

Resposta