Dom Docs
Dom Pagamentos

Editar assinatura

POSThttps://{apiUrl}/recurrence/subscriptions/{id}

Atualizado em · 1 min de leitura

Endpoint: POST https://{apiUrl}/recurrence/subscriptions/{id}

Modifica uma assinatura existente. As alterações afetam apenas as faturas ainda não emitidas.

Parâmetros

POSThttps://{apiUrl}/recurrence/subscriptions/{id}
URL base da API
Token de autenticação
Path Params
idstringrequired

Identificador único da assinatura (UUID)

curl --request POST \
  --url "https://{apiUrl}/recurrence/subscriptions/{id}" \
  --header "Content-Type: application/json" 
  --data '{}'
Response

Choose an example:

application/json

Somente as faturas ainda não emitidas serão afetadas com a alteração da assinatura. Faturas já emitidas não podem ser alteradas retroativamente.

Exemplo de resposta

json
{
  "status": "OK",
  "subscription": {
    "id": "assinatura-uuid-aqui",
    "status": "active"
  }
}
Campos da resposta
statusstring

OK em caso de sucesso, FAIL em caso de erro

subscription.idstring

UUID da assinatura editada

subscription.statusstring

Estado atual da assinatura

Esta página foi útil?