Consultar assinatura
Sem campo de autorização: o portal autentica por você com a sua chave de Homologação e as requisições rodam só no ambiente de testes.
Token de acesso devolvido por POST /auth/token. Envie como "Authorization: Bearer ". Vale 24 horas.
In: header
Path Parameters
uuidResponse Body
curl -X GET "https://pagpolar-api.creativecode.dev.br/v1/subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"data": {
"id": "f7a8b9c0-d1e2-4f3a-4b5c-6d7e8f9a0b1c",
"status": "ACTIVE",
"payment_method": "CREDIT_CARD",
"start_at": "2026-01-01T00:00:00.000Z",
"end_at": null,
"next_billing_at": "2026-09-01T00:00:00.000Z",
"next_billing_amount": 97,
"total_amount": 1164,
"canceled_at": null,
"cycle_limit": null,
"paid_at": "2026-01-01T00:05:00.000Z",
"created_at": "2026-01-01T00:00:00.000Z",
"customer": {
"id": "e6f7a8b9-c0d1-4e2f-3a4b-5c6d7e8f9a0b",
"name": "Maria Souza",
"email": "maria@exemplo.com",
"document": "***.456.***-**",
"phone": "****4321",
"is_active": true,
"created_at": "2026-01-05T08:00:00.000Z"
},
"offer": {
"id": "d5e6f7a8-b9c0-4d1e-2f3a-4b5c6d7e8f9a",
"identifier": "PPP1234567890",
"title": "Plano Mensal",
"price": 197.9,
"is_active": true,
"requires_shipping": false,
"is_default": false,
"product_id": "c4d5e6f7-a8b9-4c0d-1e2f-3a4b5c6d7e8f",
"payment_methods": {
"pix": true,
"credit_card": true,
"billet": false
},
"max_credit_card_installments": 12,
"cycle": "MONTHLY",
"cycle_interval": 1,
"cycle_interval_limit": 12,
"allow_purchase_quantity": false,
"purchase_quantity_limit": 10,
"purchase_quantity_min": 1,
"expires_at": null,
"created_at": "2026-01-10T10:00:00.000Z"
},
"product": {
"id": "c4d5e6f7-a8b9-4c0d-1e2f-3a4b5c6d7e8f",
"name": "Curso de Marketing Digital",
"description": "Aprenda a vender online do zero",
"author": "João Silva",
"promotional_text": "Oferta por tempo limitado",
"is_active": true,
"image": "https://api.pagpolar.com/files/abc123.png",
"type": "DIGITAL",
"content_type": "COURSE",
"warranty_time": 7,
"category": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Cursos"
},
"created_at": "2026-01-15T12:00:00.000Z",
"updated_at": "2026-02-01T09:30:00.000Z"
}
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"request_id": "string"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"request_id": "string"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"request_id": "string"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"request_id": "string"
}
}Assinar um plano (criar assinatura) POST
Cria uma assinatura de verdade para um cliente em uma oferta de plano existente. `id` pode ser o id (uuid) **ou** o identifier da oferta de plano — mesma resolução usada em `GET /offers/{identifier}`. Só aceita **cartão de crédito**. A cobrança do cartão é feita no gateway **depois** da resposta desta requisição: a assinatura retorna com `status: DRAFT`. O webhook `SUBSCRIPTION_CONFIRMED` avisa que o gateway aceitou a assinatura — o status continua `DRAFT` — e ela vira `ACTIVE` quando a primeira fatura é paga. Se o gateway recusar, o webhook é `SUBSCRIPTION_FAILED` e o status vira `FAILED`. Como alternativa aos webhooks, faça polling em `GET /subscriptions/{id}`. O header `Idempotency-Key` é **obrigatório**. Em caso de timeout, reenvie a requisição com a mesma chave: a resposta original será devolvida sem criar uma segunda assinatura. **Uma assinatura não é cobrada diretamente — cada ciclo cobrado (o primeiro e todas as renovações seguintes) gera uma `Transaction` própria**, a mesma entidade retornada por `GET /sales`/`GET /sales/{identifier}`. Ou seja, para acompanhar os pagamentos de uma assinatura ao longo do tempo, use os eventos de transação (`TRANSACTION_PAID`, `TRANSACTION_CANCELED`, etc.) e `GET /sales` filtrando pelo cliente/período — os eventos de assinatura (`SUBSCRIPTION_*`) informam mudanças de status da assinatura em si, não de cada cobrança individual.
Listar opções de troca de plano GET
Lista os planos do mesmo produto disponíveis para troca (upgrade ou downgrade) nesta assinatura, e se o produto permite troca de plano pelo cliente.