curl --request GET \
--url https://besimplo.com/api/v1/subscriptions/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://besimplo.com/api/v1/subscriptions/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://besimplo.com/api/v1/subscriptions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://besimplo.com/api/v1/subscriptions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://besimplo.com/api/v1/subscriptions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://besimplo.com/api/v1/subscriptions/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://besimplo.com/api/v1/subscriptions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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"
}Consultar assinatura
Consultar dados de uma assinatura existente na sua conta
curl --request GET \
--url https://besimplo.com/api/v1/subscriptions/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://besimplo.com/api/v1/subscriptions/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://besimplo.com/api/v1/subscriptions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://besimplo.com/api/v1/subscriptions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://besimplo.com/api/v1/subscriptions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://besimplo.com/api/v1/subscriptions/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://besimplo.com/api/v1/subscriptions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
A chave de API usada para autenticar a requisição e identificar a sua conta.
Exemplo: Authorization: ApiKey my-secure-key
Path Parameters
ID da assinatura, no formato TypeID com prefixo sub_.
^sub_[0-9a-z]{26}$"sub_01h455vb4pex5vsknk084sn02s"
Response
Operação realizada com sucesso
ID único da assinatura, no formato TypeID com prefixo sub_.
^sub_[0-9a-z]{26}$"sub_01h455vb4pex5vsknk084sn02s"
Indica ambiente de produção (true) ou sandbox (false). Dados de sandbox são limpos periodicamente.
true
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.
pending, active, inactive, suspended "active"
Data de início da assinatura (timestamp Unix).
1764039600
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.
card, pix null
Quantidade de parcelas para cobrança no cartão de crédito. Valor 1 indica pagamento à vista.
1 <= x <= 121
ID do cliente associado, no formato TypeID com prefixo cus_.
^cus_[0-9a-z]{26}$"cus_01h455vb4pex5vsknk084sn02p"
Show child attributes
Show child attributes
Tipo do objeto. Sempre 'subscription'.
subscription "subscription"
Código externo para integração com outros sistemas.
"ACCOUNT-SUB-XYZ"
Data de término da assinatura (timestamp Unix). Null se ainda ativa.
1795575600
Data de referência para o ciclo de cobrança (timestamp Unix).
1764039600
Início do período atual (timestamp Unix). null se a assinatura ainda não iniciou seu primeiro ciclo.
1764039600
ID da última fatura gerada, no formato TypeID com prefixo in_.
"in_01h455vb4pex5vsknk084sn02q"
Data de criação da assinatura (timestamp Unix).
1764040287
Show child attributes
Show child attributes

