v1
latestOpenAPI 3.1.02026-07-261420929.5 KBListar Planos
Retorna uma lista com todos os planos da sua conta, ordenada pela data de criação, exibindo primeiro o plano criado mais recentemente. <br><br> :warning: Importante: O parâmetro totalItems retornado após a consulta indica a quantidade total de planos cadastrados. No entanto, ele somente é incluído na resposta quando uma query é fornecida. </br></br>
get/plans
Query parameters
limitinteger
Limita em até 1.000 o número de registros listados. Caso não seja enviado, aplica-se o limite padrão de 100 registros
startinteger
Quantos registros pular do início da pesquisa (muito utilizado para paginação)
querystring
Neste parâmetro pode ser passado um texto para pesquisa. Quando utilizado, deve-se aplicar paginação (limit, start, etc).
updated_sincestring date
Registros atualizados desde o valor passado no parâmetro
Response
200
Example response
{
"items": [
{
"id": "CA1D0620A8434B2CABFF951A72EA70D6",
"name": "Plano Master",
"identifier": "master_plan",
"interval": 1,
"interval_type": "months",
"created_at": "2025-04-03T11:51:28-03:00",
"updated_at": "2025-04-03T11:51:28-03:00",
"prices": [
{
"id": "E11DC66A12414F2DB1EC78A9FDEF0C55",
"currency": "BRL",
"value_cents": 1,
"created_at": "2025-04-03T11:51:28-03:00",
"updated_at": "2025-04-03T11:51:28-03:00"
}
],
"features": [
{
"id": "1610B2CBF9504CA5BAD1FEB328953A3B",
"name": "2 aulas individuais por semana",
"identifier": "2_classes_per_week",
"value": 1,
"position": 1,
"created_at": "2025-04-03T11:51:28-03:00",
"updated_at": "2025-04-03T11:51:28-03:00"
}
],
"payable_with": [
"pix"
],
"billing_days": 5
}
],
"totalItems": 15
}