Get Billing Details
curl --request GET \
--url https://api.vertracloud.app/v1/users/me/billingimport requests
url = "https://api.vertracloud.app/v1/users/me/billing"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vertracloud.app/v1/users/me/billing', 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://api.vertracloud.app/v1/users/me/billing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://api.vertracloud.app/v1/users/me/billing"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vertracloud.app/v1/users/me/billing")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/users/me/billing")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"response": {
"name": "Ana Souza",
"address": {
"line1": "Rua das Flores",
"number": "120",
"line2": null,
"district": "Centro",
"city": "Fortaleza",
"city_code": "2304400",
"state": "CE",
"postal_code": "60000000",
"country": "BR"
},
"phone": "+5585999990000",
"tax_id": { "type": "cpf", "masked": "CPF ••• 47" },
"complete": true
}
}
Billing
Get Billing Details
Returns the billing details of the account. Requires the billing:read scope.
GET
/
v1
/
users
/
me
/
billing
Get Billing Details
curl --request GET \
--url https://api.vertracloud.app/v1/users/me/billingimport requests
url = "https://api.vertracloud.app/v1/users/me/billing"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vertracloud.app/v1/users/me/billing', 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://api.vertracloud.app/v1/users/me/billing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://api.vertracloud.app/v1/users/me/billing"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vertracloud.app/v1/users/me/billing")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/users/me/billing")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"response": {
"name": "Ana Souza",
"address": {
"line1": "Rua das Flores",
"number": "120",
"line2": null,
"district": "Centro",
"city": "Fortaleza",
"city_code": "2304400",
"state": "CE",
"postal_code": "60000000",
"country": "BR"
},
"phone": "+5585999990000",
"tax_id": { "type": "cpf", "masked": "CPF ••• 47" },
"complete": true
}
}
An order needs complete billing details. Check
complete before creating one.
Response
response is null until billing details are saved. The response is never cached.
object | null
Show Toggle object
Show Toggle object
string | null
The name on receipts and invoices.
object | null
Show Toggle object
Show Toggle object
string
Street name.
string | null
Street number, or
S/N.string | null
Complement, for example
Apt 2.string | null
Neighborhood (bairro).
string
City.
string | null
Seven-digit IBGE city code.
string | null
Two-letter state code in Brazil.
string | null
Postal code (CEP in Brazil).
string
Two-letter ISO country code.
string | null
Optional phone number, in E.164 format.
object | null
boolean
true when the details are enough to create an order (in Brazil, including the CPF/CNPJ).{
"response": {
"name": "Ana Souza",
"address": {
"line1": "Rua das Flores",
"number": "120",
"line2": null,
"district": "Centro",
"city": "Fortaleza",
"city_code": "2304400",
"state": "CE",
"postal_code": "60000000",
"country": "BR"
},
"phone": "+5585999990000",
"tax_id": { "type": "cpf", "masked": "CPF ••• 47" },
"complete": true
}
}
Error Responses
string
The error code indicating the reason for failure. Possible values:
UNAUTHORIZED: The user is not authenticated.USER_NOT_FOUND: The authenticated user was not found.INTERNAL_SERVER_ERROR: An unexpected server error occurred.
{
"code": "UNAUTHORIZED"
}