Skip to main content
GET
/
api
/
v1
/
subscriptions
/
{id}
Consultar assinatura
curl --request GET \
  --url https://besimplo.com/api/v1/subscriptions/{id} \
  --header 'Authorization: <api-key>'
{
  "id": "sub_01h455vb4pex5vsknk084sn02s",
  "object": "subscription",
  "external_code": "ACCOUNT-SUB-XYZ",
  "billing_cycle_anchor": 1764039600,
  "created": 1764040287,
  "customer": "cus_01h455vb4pex5vsknk084sn02p",
  "payment_method_type": null,
  "installments": 1,
  "current_period_start": 1764039600,
  "latest_invoice": "in_01h455vb4pex5vsknk084sn02q",
  "discounts": {
    "object": "list",
    "data": [
      {
        "coupon": "sdi_01h455vb4pex5vsknk084sn02d"
      }
    ]
  },
  "ended": null,
  "item": {
    "id": "si_01h455vb4pex5vsknk084sn02i",
    "object": "subscription_item",
    "created": 1764040287,
    "current_period_end": 1766631600,
    "current_period_start": 1764039600,
    "price": {
      "id": "price_01h455vb4pex5vsknk084sn02q",
      "object": "price",
      "active": true,
      "created": 1764040287,
      "product": "prod_01h455vb4pex5vsknk084sn02q",
      "type": "recurring",
      "interval": "month",
      "interval_count": 1,
      "unit_amount": 50000,
      "unit_amount_decimal": "50000",
      "nickname": "Preço mensal básico"
    },
    "quantity": 1,
    "subscription": "sub_01h455vb4pex5vsknk084sn02s"
  },
  "start_date": 1764039600,
  "status": "pending"
}

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

Path Parameters

​
id
string
required

ID da assinatura, no formato TypeID com prefixo sub_.

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

"sub_01h455vb4pex5vsknk084sn02s"

Response

Operação realizada com sucesso

​
id
string
required
read-only

ID único da assinatura, no formato TypeID com prefixo sub_.

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

"sub_01h455vb4pex5vsknk084sn02s"

​
live_mode
boolean
required

Indica ambiente de produção (true) ou sandbox (false). Dados de sandbox são limpos periodicamente.

Example:

true

​
status
enum<string>
required

Status da assinatura:

  • pending: Assinatura criada, aguardando primeiro pagamento.
  • active: Primeiro pagamento confirmado. Assinatura ativa.
  • inactive: Assinatura cancelada.
  • suspended: Assinatura suspensa por falha de pagamento.
Available options:
pending,
active,
inactive,
suspended
Example:

"active"

​
start_date
integer<int64>
required

Data de início da assinatura (timestamp Unix).

Example:

1764039600

​
payment_method_type
enum<string> | null
required

Método de pagamento da assinatura:

  • card: Cartão de crédito.
  • pix: Pagamento instantâneo via PIX.
  • null: Ainda não definido até a confirmação do primeiro pagamento.
Available options:
card,
pix
Example:

null

​
installments
integer
default:1
required

Quantidade de parcelas para cobrança no cartão de crédito. Valor 1 indica pagamento à vista.

Required range: 1 <= x <= 12
Example:

1

​
customer
string
required

ID do cliente associado, no formato TypeID com prefixo cus_.

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

"cus_01h455vb4pex5vsknk084sn02p"

​
item
object
required
​
object
enum<string>

Tipo do objeto. Sempre 'subscription'.

Available options:
subscription
Example:

"subscription"

​
external_code
string | null

Código externo para integração com outros sistemas.

Example:

"ACCOUNT-SUB-XYZ"

​
ended
integer | null

Data de término da assinatura (timestamp Unix). Null se ainda ativa.

Example:

1795575600

​
billing_cycle_anchor
integer<int64>

Data de referência para o ciclo de cobrança (timestamp Unix).

Example:

1764039600

​
current_period_start
integer | null

Início do período atual (timestamp Unix). null se a assinatura ainda não iniciou seu primeiro ciclo.

Example:

1764039600

​
latest_invoice
string | null

ID da última fatura gerada, no formato TypeID com prefixo in_.

Example:

"in_01h455vb4pex5vsknk084sn02q"

​
created
integer<int64>
read-only

Data de criação da assinatura (timestamp Unix).

Example:

1764040287

​
discounts
object