Listar assinaturas
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
Query Parameters
Número da página, começando em 1.
11 <= valueItens por página, de 1 a 100.
251 <= value <= 100Situação da assinatura.
"DRAFT" | "PENDING_PAYMENT" | "ACTIVE" | "PENDING_RENEWAL" | "PROCESSING" | "CANCELING" | "CANCELED" | "ASK_REFUND" | "REFUNDED" | "ABANDONED" | "EXPIRED" | "FAILED"Assinaturas deste plano.
uuidE-mail do cliente da assinatura. E-mail completo, sem diferenciar maiúsculas de minúsculas.
emailDocumento do cliente da assinatura. CPF com 11 dígitos ou CNPJ com 14, com ou sem pontuação.
Assinaturas criadas a partir desta data e hora, incluindo ela. ISO 8601 com fuso.
date-timeAssinaturas criadas até esta data e hora, incluindo ela. ISO 8601 com fuso.
date-timeResponse Body
curl -X GET "https://pagpolar-api.creativecode.dev.br/v1/subscriptions?page=1&per_page=25&status=DRAFT&plan_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&customer_email=user%40example.com&customer_document=123.456.789-09&created_from=2019-08-24T14%3A15%3A22Z&created_to=2019-08-24T14%3A15%3A22Z"{
"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"
}
}
],
"meta": {
"page": 1,
"per_page": 25,
"total": 143,
"total_pages": 6
}
}{
"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"
}
}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.
Calcular preview de troca de plano POST
Calcula o crédito ou cobrança proporcional de uma troca de plano sem efetivá-la. Não tem efeito colateral.