Skip to main content
POST
/
cycles
Criar assinatura
curl --request POST \
  --url https://api.pagozz.com/v1/cycles \
  --header 'Content-Type: application/json' \
  --header 'Pagozz-Token: <api-key>' \
  --data '
{
  "plan_id": "p1a2b3c4-d5e6-7890-abcd-ef1234567890",
  "subscriber_email": "cliente@email.com",
  "payment_method": "pix"
}
'
{
  "data": {
    "id": "c1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "plan_id": "p1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "subscriber_account_id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "status": "trialing",
    "current_period_start": "2026-03-01T10:00:00Z",
    "current_period_end": "2026-03-08T10:00:00Z",
    "next_billing_at": "2026-03-08T10:00:00Z",
    "anchor_day": null,
    "payment_method": "pix",
    "billing_count": 0,
    "paid_count": 0,
    "credit_balance": 0,
    "cancel_at_period_end": false,
    "canceled_at": null,
    "cancellation_reason": null,
    "trial_start": "2026-03-01T10:00:00Z",
    "trial_end": "2026-03-08T10:00:00Z",
    "environment": "test",
    "created_at": "2026-03-01T10:00:00Z",
    "updated_at": "2026-03-01T10:00:00Z"
  }
}

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.

Body

application/json

Dados para criação de uma nova assinatura.

​
plan_id
string<uuid>
required

Obrigatório. ID do plano de assinatura.

​
subscriber_email
string<email>
required

Obrigatório. Email do subscriber.

​
payment_method
enum<string>
default:pix

Opcional. Método de pagamento. Padrão: pix.

Available options:
pix,
credit_card

Response

Assinatura criada com sucesso.

​
data
object

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