Skip to main content
POST
/
cycles
/
{id}
/
cancel
Cancelar assinatura
curl --request POST \
  --url https://api.pagozz.com/v1/cycles/{id}/cancel \
  --header 'Content-Type: application/json' \
  --header 'Pagozz-Token: <api-key>' \
  --data '
{
  "reason": "Cliente solicitou cancelamento"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subscriber_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "trialing",
    "current_period_start": "2023-11-07T05:31:56Z",
    "current_period_end": "2023-11-07T05:31:56Z",
    "next_billing_at": "2023-11-07T05:31:56Z",
    "anchor_day": 123,
    "payment_method": "<string>",
    "billing_count": 123,
    "paid_count": 123,
    "credit_balance": 123,
    "cancel_at_period_end": true,
    "canceled_at": "2023-11-07T05:31:56Z",
    "cancellation_reason": "<string>",
    "trial_start": "2023-11-07T05:31:56Z",
    "trial_end": "2023-11-07T05:31:56Z",
    "environment": "test",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Pagozz-Token
string
header
required

Chave de API no formato pgz_test_* (test mode) ou pgz_live_* (live mode). O ambiente é determinado automaticamente pelo prefixo da chave.

Path Parameters

​
id
string<uuid>
required

ID do recurso (UUID).

Body

application/json
​
reason
string | null

Motivo do cancelamento (opcional).

Response

Assinatura cancelada com sucesso.

​
data
object

Representa uma assinatura (cycle) ativa de um subscriber a um plano.