---
title: "Listar assinaturas"
url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5/operations/listar-assinaturas-1"
---
> Full API specification: https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5.md
# Listar assinaturas
`GET` `/subscriptions`
Operation ID: `listar-assinaturas-1`
Este recurso permite listar as assinaturas. Pode ser utilizados alguns parâmetros como filtro da listagem.
## Query parameters
- `status` (string, optional) - Status da assinatura.
Valores possíveis: **active**, **canceled** ou **future**
- `code` (string, optional) - Código da assinatura no sistema da loja. Máx.: 52 caracteres
- `billing_type` (string, optional) - Tipo de cobrança.
Valores possíveis: **prepaid**, **postpaid **ou **exact_day**.
- `customer_id` (string, optional) - Código do cliente. [Saiba mais sobre clientes](https://docs.pagar.me/reference/clientes-1).
- `plan_id` (string, optional) - Código do plano.
Formato: `plan_XXXXXXXXXXXXXXXX`.
- `card_id` (string, optional) - Código do cartão.
Formato: `card_XXXXXXXXXXXXXXXX`.
- `next_billing_since` (string, date, optional) - Data de início da próxima data de cobrança.
- `next_billing_until` (string, date, optional) - Data final de próxima data de cobrança.
- `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
- `401` - 401
## 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:
/subscriptions:
get:
summary: Listar assinaturas
description: Este recurso permite listar as assinaturas. Pode ser utilizados
alguns parâmetros como filtro da listagem.
operationId: listar-assinaturas-1
parameters:
- name: status
in: query
description: "Status da assinatura.
Valores possíveis: **active**,
**canceled** ou **future**"
schema:
type: string
- name: code
in: query
description: "Código da assinatura no sistema da loja. Máx.: 52 caracteres"
schema:
type: string
- name: billing_type
in: query
description: "Tipo de cobrança.
Valores possíveis: **prepaid**, **postpaid
**ou **exact_day**."
schema:
type: string
- name: customer_id
in: query
description: Código do cliente. [Saiba mais sobre
clientes](https://docs.pagar.me/reference/clientes-1).
schema:
type: string
- name: plan_id
in: query
description: "Código do plano.
Formato: `plan_XXXXXXXXXXXXXXXX`."
schema:
type: string
- name: card_id
in: query
description: "Código do cartão.
Formato: `card_XXXXXXXXXXXXXXXX`."
schema:
type: string
- name: next_billing_since
in: query
description: Data de início da próxima data de cobrança.
schema:
type: string
format: date
- name: next_billing_until
in: query
description: Data final de próxima data de cobrança.
schema:
type: string
format: date
- 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
default: 1
- name: size
in: query
description: Quantidade de itens por página.
schema:
type: integer
format: int32
default: 10
responses:
"200":
description: "200"
content:
application/json:
examples:
Result:
value: >-
{
"data": [
{
"id": "sub_05jkdIfGYPfN26mI",
"payment_method": "credit_card",
"currency": "BRL",
"interval": "month",
"gateway_affiliation_id": "C56A4180-65AA-42EC-A945-5FD21DEC0538",
"boleto_due_days": 5,
"minimum_price": 10000,
"interval_count": 3,
"billing_type": "prepaid",
"current_cycle": {
"start_at": "2016-07-19T00:00:00Z",
"end_at": "2016-10-18T23:59:59Z"
},
"next_billing_at": "2016-10-19T00:00:00Z",
"installments": 3,
"customer": {
"id": "cus_017228NmffGbA3d4",
"name": "Luke Skywalker",
"email": "lskywalker@r2d2.com",
"delinquent": false,
"created_at": "2016-07-12T18:25:40Z",
"updated_at": "2016-07-12T18:25:40Z"
},
"credit_card": {
"id": "card_Mome2meGz4PDNQbX",
"holder_name": "Luke Skywalker",
"masked_number": "402400******4251",
"exp_month": 6,
"exp_year": 17,
"expired": false,
"status": "active",
"created_at": "2016-07-12T18:25:40Z",
"update_at": "2016-07-12T18:25:40Z",
"billing_address": {
"line_1": "10880, Malibu Point, Malibu Central",
"zip_code": "90265",
"city": "Malibu",
"state": "CA",
"country": "US"
}
},
"discounts": [
{
"id": "si_k2zpBDMsOs0fDfHe",
"cycles": 3,
"value": 10,
"discount_type": "percentage",
"created_at": "2016-07-12T18:25:40Z"
}
],
"increments": [
{
"id": "inc_IYzpxgjsOs0fDIoP",
"cycles": 2,
"value": 20,
"discount_type": "percentage",
"created_at": "2016-07-12T18:25:40Z"
}
],
"items": [
{
"id": "si_B6555Riyq9lj6klS",
"description": "Musculação",
"quantity": 1,
"pricing_scheme": {
"price": 18990,
"scheme_type": "unit"
},
"status": "active",
"created_at": "2016-07-12T18:25:40Z",
"updated_at": "2016-07-12T18:25:40Z"
}
],
"status": "active",
"created_at": "2016-07-12T18:25:40Z",
"updated_at": "2016-07-12T18:25:40Z",
"metadata": {
"id": "my_subscription_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: sub_05jkdIfGYPfN26mI
payment_method:
type: string
example: credit_card
currency:
type: string
example: BRL
interval:
type: string
example: month
gateway_affiliation_id:
type: string
example: C56A4180-65AA-42EC-A945-5FD21DEC0538
boleto_due_days:
type: integer
example: 5
default: 0
minimum_price:
type: integer
example: 10000
default: 0
interval_count:
type: integer
example: 3
default: 0
billing_type:
type: string
example: prepaid
current_cycle:
type: object
properties:
start_at:
type: string
example: 2016-07-19T00:00:00Z
end_at:
type: string
example: 2016-10-18T23:59:59Z
next_billing_at:
type: string
example: 2016-10-19T00:00:00Z
installments:
type: integer
example: 3
default: 0
customer:
type: object
properties:
id:
type: string
example: cus_017228NmffGbA3d4
name:
type: string
example: Luke Skywalker
email:
type: string
example: lskywalker@r2d2.com
delinquent:
type: boolean
example: false
default: true
created_at:
type: string
example: 2016-07-12T18:25:40Z
updated_at:
type: string
example: 2016-07-12T18:25:40Z
credit_card:
type: object
properties:
id:
type: string
example: card_Mome2meGz4PDNQbX
holder_name:
type: string
example: Luke Skywalker
masked_number:
type: string
example: 402400******4251
exp_month:
type: integer
example: 6
default: 0
exp_year:
type: integer
example: 17
default: 0
expired:
type: boolean
example: false
default: true
status:
type: string
example: active
created_at:
type: string
example: 2016-07-12T18:25:40Z
update_at:
type: string
example: 2016-07-12T18:25:40Z
billing_address:
type: object
properties:
line_1:
type: string
example: 10880, Malibu Point, Malibu Central
zip_code:
type: string
example: "90265"
city:
type: string
example: Malibu
state:
type: string
example: CA
country:
type: string
example: US
discounts:
type: array
items:
type: object
properties:
id:
type: string
example: si_k2zpBDMsOs0fDfHe
cycles:
type: integer
example: 3
default: 0
value:
type: integer
example: 10
default: 0
discount_type:
type: string
example: percentage
created_at:
type: string
example: 2016-07-12T18:25:40Z
increments:
type: array
items:
type: object
properties:
id:
type: string
example: inc_IYzpxgjsOs0fDIoP
cycles:
type: integer
example: 2
default: 0
value:
type: integer
example: 20
default: 0
discount_type:
type: string
example: percentage
created_at:
type: string
example: 2016-07-12T18:25:40Z
items:
type: array
items:
type: object
properties:
id:
type: string
example: si_B6555Riyq9lj6klS
description:
type: string
example: Musculação
quantity:
type: integer
example: 1
default: 0
pricing_scheme:
type: object
properties:
price:
type: integer
example: 18990
default: 0
scheme_type:
type: string
example: unit
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
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
metadata:
type: object
properties:
id:
type: string
example: my_subscription_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
"401":
description: "401"
content:
application/json:
examples:
Result:
value: >-
{
"message": "Authorization has been denied for this request."
}
schema:
type: object
properties:
message:
type: string
example: Authorization has been denied for this request.
deprecated: false
security:
- sec0: []
components:
securitySchemes:
sec0:
type: http
scheme: basic
```