Skip to main content
PATCH
Cancelar assinatura

Authorizations

X-Client-Id
string
header
required
X-Api-Key
string
header
required

Path Parameters

id
string<uuid>
required

Id da assinatura que deseja cancelar

Body

application/json
cancellationReason
string

Motivo do cancelamento. É gravado, mas não volta nas respostas da API

Example:

"Cliente pediu o cancelamento"

Response

Success

id
string<uuid>

Identificador da assinatura

Example:

"019860b2-feb8-7edf-b5ba-0c48a7a8bd3f"

status
enum<string>

Status da assinatura depois do cancelamento

Available options:
created,
active,
paused,
canceled,
unpaid,
expired,
trialing
Example:

"canceled"

message
string

Mensagem fixa, em inglês, que confirma a operação

Example:

"Subscription canceled successfully"

updatedAt
string<date-time>

Data da atualização do status

Example:

"2025-07-31T14:00:00Z"