Atualizar assinatura existente
Atualiza uma assinatura existente com base no ID fornecido. Nota: É necessário fornecer o ID da assinatura que deseja atualizar.
Request Body required
Descreve os dados a serem incluídos no corpo da requisição.
customer object required
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.
plan object required
O ID do plano a que a nova assinatura será vinculada.
- 200
- 401
- 422
- 500
Assinatura atualizada com sucesso
Schema
O ID da assinatura.
O UUID da assinatura.
O ID do plano da assinatura.
O plano da assinatura.
O ID do cliente da assinatura.
O cliente da assinatura.
O método da assinatura.
O ID do cartão de crédito da assinatura.
O cartão de crédito da assinatura.
O valor recorrente da assinatura.
O valor da assinatura.
Os últimos dígitos do cartão da assinatura.
Os produtos da assinatura.
O histórico da assinatura.
Os cupons da assinatura.
O status da assinatura.
A razão do cancelamento da assinatura.
O tipo de cancelamento da assinatura.
O cancelamento voluntário da assinatura.
A data de início da assinatura.
A data e hora em que a assinatura foi criada.
A data e hora em que a assinatura foi atualizada.
A data de término da assinatura.
A data e hora do próximo pagamento da assinatura.
As tentativas da assinatura.
Os dados personalizados da assinatura.
A empresa da assinatura.
A habilitação da cobrança da assinatura.
O contrato do cliente da assinatura.
{
"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": [
null
],
"histories": [
null
],
"coupons": [
null
],
"status": "string",
"reason_cancel": "string",
"cancel_type": "string",
"voluntary_cancel": true,
"start": "2024-10-02",
"created_at": "2024-10-02T18:42:13.264Z",
"updated_at": "2024-10-02T18:42:13.264Z",
"end": "2024-10-02",
"next_payment": "2024-10-02T18:42:13.264Z",
"retries": 0,
"custom_data": {},
"company": {},
"charge_enabled": true,
"customerContract": {}
}
Não autorizado
Schema
{
"message": "string"
}
{
"message": "Unauthenticated"
}
Erro na validação de dados
Schema
errors object
{
"message": "string",
"errors": {}
}
{
"message": "The given data was invalid.",
"errors": {
"name": "The name field is required."
}
}
Houve um erro inesperado
Schema
{
"message": "string"
}
{
"message": "An unexpected error occurred"
}