Skip to main content
GET
/
api
/
v1
/
subscriptions
Listar assinaturas
curl --request GET \
  --url https://besimplo.com/api/v1/subscriptions \
  --header 'Authorization: <api-key>'
{
  "object": "list",
  "data": [
    {
      "id": "sub_01h455vb4pex5vsknk084sn02s",
      "live_mode": true,
      "status": "active",
      "start_date": 1764039600,
      "payment_method_type": null,
      "installments": 1,
      "customer": "cus_01h455vb4pex5vsknk084sn02p",
      "item": {
        "id": "si_01h455vb4pex5vsknk084sn02i",
        "object": "subscription_item",
        "price": {
          "id": "price_01h455vb4pex5vsknk084sn02q",
          "object": "price",
          "currency": "brl",
          "unit_amount": 123,
          "product": "prod_01h455vb4pex5vsknk084sn02q",
          "active": true,
          "type": "recurring",
          "unit_amount_decimal": "500",
          "recurring_interval": "day",
          "recurring_interval_count": 123,
          "created": 1764040287,
          "nickname": "Preço mensal básico"
        },
        "quantity": 123,
        "created": 1764040287,
        "current_period_end": 1764039600,
        "current_period_start": 1764039600,
        "subscription": "sub_01h455vb4pex5vsknk084sn02s"
      },
      "object": "subscription",
      "external_code": "ACCOUNT-SUB-XYZ",
      "ended": 1795575600,
      "billing_cycle_anchor": 1764039600,
      "current_period_start": 1764039600,
      "latest_invoice": "in_01h455vb4pex5vsknk084sn02q",
      "created": 1764040287,
      "discounts": {
        "object": "list",
        "data": [
          {
            "id": "sdi_01h455vb4pex5vsknk084sn02d",
            "object": "discount"
          }
        ]
      }
    }
  ],
  "has_more": false,
  "url": "/api/v1/subscriptions"
}

Documentation Index

Fetch the complete documentation index at: https://docs.besimplo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

A chave de API usada para autenticar a requisição e identificar a sua conta.

Exemplo: Authorization: ApiKey my-secure-key

Query Parameters

​
customer
string

Filtrar pelo ID do cliente (TypeID com prefixo cus_).

Pattern: ^cus_[0-9a-z]{26}$
Example:

"cus_01h455vb4pex5vsknk084sn02p"

​
status
enum<string>

Filtrar por status da assinatura.

Available options:
pending,
active,
inactive,
suspended
​
limit
integer
default:20

Resultados por página

Required range: 1 <= x <= 100
​
page
string

Cursor para próxima página

Response

Lista de assinaturas

Lista paginada de assinaturas.

​
object
enum<string>
required

Tipo do objeto. Sempre 'list'.

Available options:
list
Example:

"list"

​
data
object[]
required

Assinaturas retornadas.

​
has_more
boolean
required

Indica se existem mais páginas de resultados.

Example:

false

​
url
string<uri-reference>
required

Endpoint da listagem.

Example:

"/api/v1/subscriptions"