---
title: "Listar planos"
url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5/operations/listar-planos-1"
---
> Full API specification: https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5.md
# Listar planos
`GET` `/plans`
Operation ID: `listar-planos-1`
Este recurso permite listar seus planos. Pode ser utilizados alguns parâmetros como filtro da listagem.
## Query parameters
- `name` (string, optional) - Nome do plano.
- `status` (string, optional) - Status do plano.
Valores possíveis: **active**, **inactive** ou **deleted**
- `created_since` (string, date, optional) - Data de início do período de criação a ser listado.
- `created_until` (string, date, optional) - Data final do período de criação a ser listado.
- `page` (integer, int32, optional) - Página atual.
- `size` (integer, int32, optional) - Quantidade de itens por página.
## Responses
- `200` - 200
- `404` - 404
## OpenAPI definition
```yaml
openapi: 3.1.0
info:
title: Pagar.me v5 API (Legado)
version: 5.0.0
servers:
- url: https://api.stone.com.br/core/v5
paths:
/plans:
get:
summary: Listar planos
description: Este recurso permite listar seus planos. Pode ser utilizados alguns
parâmetros como filtro da listagem.
operationId: listar-planos-1
parameters:
- name: name
in: query
description: Nome do plano.
schema:
type: string
- name: status
in: query
description: "Status do plano.
Valores possíveis: **active**, **inactive** ou
**deleted**"
schema:
type: string
- name: created_since
in: query
description: Data de início do período de criação a ser listado.
schema:
type: string
format: date
- name: created_until
in: query
description: Data final do período de criação a ser listado.
schema:
type: string
format: date
- name: page
in: query
description: Página atual.
schema:
type: integer
format: int32
- name: size
in: query
description: Quantidade de itens por página.
schema:
type: integer
format: int32
responses:
"200":
description: "200"
content:
application/json:
examples:
Result:
value: |-
{
"data": [
{
"id": "plan_21r4CTG0ux77Qv13",
"name": "Plano Gold",
"url": "/plan_21r4CTG0ux77Qv13/academia/plano-gold",
"minimum_price": 10000,
"currency": "BRL",
"interval": "month",
"interval_count": 3,
"billing_type": "prepaid",
"installments": 3,
"status": "active",
"created_at": "2016-07-12T18:25:40Z",
"updated_at": "2016-07-12T18:25:40Z",
"items": [
{
"id": "pi_3j1EG9ousipHjcUL",
"name": "Musculação",
"status": "active",
"created_at": "2016-07-12T18:25:40Z",
"updated_at": "2016-07-12T18:25:40Z",
"pricing_scheme": {
"price": 18990,
"scheme_type": "unit"
}
},
{
"id": "pi_6ggvuaJNS2LVq1i6",
"name": "Matrícula",
"cycles": 1,
"status": "active",
"created_at": "2016-07-12T18:25:40Z",
"updated_at": "2016-07-12T18:25:40Z",
"pricing_scheme": {
"price": 5990,
"scheme_type": "unit"
}
}
],
"metadata": {
"id": "my_plan_id"
}
}
],
"paging": {
"total_items": 1,
"current_page": 1,
"total_pages": 1
}
}
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
example: plan_21r4CTG0ux77Qv13
name:
type: string
example: Plano Gold
url:
type: string
example: /plan_21r4CTG0ux77Qv13/academia/plano-gold
minimum_price:
type: integer
example: 10000
default: 0
currency:
type: string
example: BRL
interval:
type: string
example: month
interval_count:
type: integer
example: 3
default: 0
billing_type:
type: string
example: prepaid
installments:
type: integer
example: 3
default: 0
status:
type: string
example: active
created_at:
type: string
example: 2016-07-12T18:25:40Z
updated_at:
type: string
example: 2016-07-12T18:25:40Z
items:
type: array
items:
type: object
properties:
id:
type: string
example: pi_3j1EG9ousipHjcUL
name:
type: string
example: Musculação
status:
type: string
example: active
created_at:
type: string
example: 2016-07-12T18:25:40Z
updated_at:
type: string
example: 2016-07-12T18:25:40Z
pricing_scheme:
type: object
properties:
price:
type: integer
example: 18990
default: 0
scheme_type:
type: string
example: unit
metadata:
type: object
properties:
id:
type: string
example: my_plan_id
paging:
type: object
properties:
total_items:
type: integer
example: 1
default: 0
current_page:
type: integer
example: 1
default: 0
total_pages:
type: integer
example: 1
default: 0
"404":
description: "404"
content:
application/json:
examples:
Result:
value: |-
{
"message": "Plan not found."
}
schema:
type: object
properties:
message:
type: string
example: Plan not found.
deprecated: false
security:
- sec0: []
components:
securitySchemes:
sec0:
type: http
scheme: basic
```