curl --request GET \
--url https://besimplo.com/api/v1/invoices/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://besimplo.com/api/v1/invoices/{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/invoices/{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/invoices/{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/invoices/{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/invoices/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://besimplo.com/api/v1/invoices/{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": "in_01h455vb4pex5vsknk084sn02q",
"object": "invoice",
"amount_due": 9990,
"created": 1704672000,
"currency": "brl",
"customer": "cus_01h455vb4pex5vsknk084sn02p",
"live_mode": true,
"status": "open",
"total": 9990,
"amount_paid": 0,
"amount_refunded": 0,
"amount_remaining": 9990,
"customer_email": "joao.silva@exemplo.com",
"customer_name": "João Silva",
"external_code": "PEDIDO-123",
"paid": false,
"payment_intent": "pi_01h455vb4pex5vsknk084sn02r",
"status_transitions": {
"paid_at": 1704758400
},
"subscription": "sub_01h455vb4pex5vsknk084sn02s"
}Consultar fatura
Consultar uma fatura existente na sua conta pelo ID.
curl --request GET \
--url https://besimplo.com/api/v1/invoices/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://besimplo.com/api/v1/invoices/{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/invoices/{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/invoices/{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/invoices/{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/invoices/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://besimplo.com/api/v1/invoices/{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": "in_01h455vb4pex5vsknk084sn02q",
"object": "invoice",
"amount_due": 9990,
"created": 1704672000,
"currency": "brl",
"customer": "cus_01h455vb4pex5vsknk084sn02p",
"live_mode": true,
"status": "open",
"total": 9990,
"amount_paid": 0,
"amount_refunded": 0,
"amount_remaining": 9990,
"customer_email": "joao.silva@exemplo.com",
"customer_name": "João Silva",
"external_code": "PEDIDO-123",
"paid": false,
"payment_intent": "pi_01h455vb4pex5vsknk084sn02r",
"status_transitions": {
"paid_at": 1704758400
},
"subscription": "sub_01h455vb4pex5vsknk084sn02s"
}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 fatura.
^in_[0-9a-z]{26}$"in_01h455vb4pex5vsknk084sn02q"
Response
Operação realizada com sucesso
ID único da fatura, no formato TypeID com prefixo in_.
^in_[0-9a-z]{26}$"in_01h455vb4pex5vsknk084sn02q"
Tipo do objeto. Sempre 'invoice'.
invoice "invoice"
Valor a pagar em centavos. R$ 99,90 = 9990.
9990
Timestamp Unix da criação da fatura.
1704672000
Moeda do valor. Sempre 'brl' (Real brasileiro).
brl "brl"
ID do cliente associado à fatura, no formato TypeID com prefixo cus_.
^cus_[0-9a-z]{26}$"cus_01h455vb4pex5vsknk084sn02p"
Indica ambiente de produção (true) ou sandbox (false). Dados de sandbox são limpos periodicamente.
true
Status atual da fatura.
- draft: Rascunho, ainda não finalizada.
- open: Aberta, aguardando pagamento.
- paid: Paga.
- uncollectible: Marcada como incobrável.
- void: Cancelada.
draft, open, paid, uncollectible, void "open"
Valor total da fatura em centavos. R$ 99,90 = 9990.
9990
Valor já pago em centavos. R$ 99,90 = 9990.
0
Valor estornado em centavos. Permanece separado de status: uma fatura
paga continua com status: paid depois de um estorno total ou parcial.
0
Valor restante a pagar em centavos. R$ 99,90 = 9990.
9990
E-mail do cliente.
"joao.silva@exemplo.com"
Nome do cliente.
"João Silva"
Código externo para integração com outros sistemas. Único por conta.
"PEDIDO-123"
Indica se a fatura foi paga.
false
ID da cobrança associada à fatura, no formato TypeID com prefixo pi_.
null enquanto a fatura ainda não tem cobrança gerada.
"pi_01h455vb4pex5vsknk084sn02r"
Timestamps de quando a fatura mudou de status. Campos são null se a transição ainda não ocorreu.
Show child attributes
Show child attributes
ID da assinatura associada (se aplicável), no formato TypeID com prefixo sub_.
"sub_01h455vb4pex5vsknk084sn02s"

