Skip to main content
GET
/
billing_profiles
/
{billing_profile_token}
Get billing profile by token
curl --request GET \
  --url https://api.vantage.sh/v2/billing_profiles/{billing_profile_token} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.vantage.sh/v2/billing_profiles/{billing_profile_token}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vantage.sh/v2/billing_profiles/{billing_profile_token}', 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.vantage.sh/v2/billing_profiles/{billing_profile_token}",
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: Bearer <token>"
],
]);

$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.vantage.sh/v2/billing_profiles/{billing_profile_token}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

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.vantage.sh/v2/billing_profiles/{billing_profile_token}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.vantage.sh/v2/billing_profiles/{billing_profile_token}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "token": "<string>",
  "nickname": "<string>",
  "created_at": "2023-08-04T00:00:00Z",
  "updated_at": "2023-08-04T00:00:00Z",
  "billing_information_attributes": {
    "token": "<string>",
    "company_name": "<string>",
    "country_code": "<string>",
    "address_line_1": "<string>",
    "address_line_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "billing_email": [
      "<string>"
    ]
  },
  "business_information_attributes": {
    "token": "<string>",
    "metadata": {
      "custom_fields": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  },
  "invoice_adjustment_attributes": {
    "token": "<string>",
    "adjustment_items": [
      {
        "name": "<string>",
        "amount": "<string>"
      }
    ]
  },
  "managed_accounts_count": "<string>",
  "banking_information_attributes": {
    "token": "<string>",
    "bank_name": "<string>",
    "beneficiary_name": "<string>",
    "tax_id": "<string>",
    "secure_data": {
      "account_number": "<string>",
      "routing_number": "<string>",
      "iban": "<string>",
      "swift_bic": "<string>"
    }
  }
}
{
"errors": [
"<string>"
],
"links": {
"self": "<string>",
"first": "<string>",
"next": "<string>",
"last": "<string>",
"prev": "<string>"
}
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

billing_profile_token
string
required

Response

BillingProfile model

token
string
required
nickname
string
required

Display name for the billing profile

created_at
string
required

The date and time, in UTC, the billing profile was created. ISO 8601 formatted.

Example:

"2023-08-04T00:00:00Z"

updated_at
string
required

The date and time, in UTC, the billing profile was last updated. ISO 8601 formatted.

Example:

"2023-08-04T00:00:00Z"

billing_information_attributes
object
required
business_information_attributes
object
required
invoice_adjustment_attributes
object
required
managed_accounts_count
string
required

Number of managed accounts using this billing profile

banking_information_attributes
object