Skip to main content
POST
/
billing_profiles
Create billing profile
curl --request POST \
  --url https://api.vantage.sh/v2/billing_profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nickname": "<string>",
  "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>"
        }
      ]
    }
  },
  "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>"
    }
  },
  "invoice_adjustment_attributes": {
    "token": "<string>",
    "adjustment_items": [
      {
        "name": "<string>",
        "amount": 123,
        "adjustment_type": "charge"
      }
    ]
  }
}
'
import requests

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

payload = {
    "nickname": "<string>",
    "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>"
                }
            ] }
    },
    "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>"
        }
    },
    "invoice_adjustment_attributes": {
        "token": "<string>",
        "adjustment_items": [
            {
                "name": "<string>",
                "amount": 123,
                "adjustment_type": "charge"
            }
        ]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    nickname: '<string>',
    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>'}]}
    },
    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>'
      }
    },
    invoice_adjustment_attributes: {
      token: '<string>',
      adjustment_items: [{name: '<string>', amount: 123, adjustment_type: 'charge'}]
    }
  })
};

fetch('https://api.vantage.sh/v2/billing_profiles', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'nickname' => '<string>',
    '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>'
                                ]
                ]
        ]
    ],
    '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>'
        ]
    ],
    'invoice_adjustment_attributes' => [
        'token' => '<string>',
        'adjustment_items' => [
                [
                                'name' => '<string>',
                                'amount' => 123,
                                'adjustment_type' => 'charge'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"nickname\": \"<string>\",\n  \"billing_information_attributes\": {\n    \"token\": \"<string>\",\n    \"company_name\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"address_line_1\": \"<string>\",\n    \"address_line_2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"billing_email\": [\n      \"<string>\"\n    ]\n  },\n  \"business_information_attributes\": {\n    \"token\": \"<string>\",\n    \"metadata\": {\n      \"custom_fields\": [\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"banking_information_attributes\": {\n    \"token\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"beneficiary_name\": \"<string>\",\n    \"tax_id\": \"<string>\",\n    \"secure_data\": {\n      \"account_number\": \"<string>\",\n      \"routing_number\": \"<string>\",\n      \"iban\": \"<string>\",\n      \"swift_bic\": \"<string>\"\n    }\n  },\n  \"invoice_adjustment_attributes\": {\n    \"token\": \"<string>\",\n    \"adjustment_items\": [\n      {\n        \"name\": \"<string>\",\n        \"amount\": 123,\n        \"adjustment_type\": \"charge\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.vantage.sh/v2/billing_profiles")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"nickname\": \"<string>\",\n  \"billing_information_attributes\": {\n    \"token\": \"<string>\",\n    \"company_name\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"address_line_1\": \"<string>\",\n    \"address_line_2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"billing_email\": [\n      \"<string>\"\n    ]\n  },\n  \"business_information_attributes\": {\n    \"token\": \"<string>\",\n    \"metadata\": {\n      \"custom_fields\": [\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"banking_information_attributes\": {\n    \"token\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"beneficiary_name\": \"<string>\",\n    \"tax_id\": \"<string>\",\n    \"secure_data\": {\n      \"account_number\": \"<string>\",\n      \"routing_number\": \"<string>\",\n      \"iban\": \"<string>\",\n      \"swift_bic\": \"<string>\"\n    }\n  },\n  \"invoice_adjustment_attributes\": {\n    \"token\": \"<string>\",\n    \"adjustment_items\": [\n      {\n        \"name\": \"<string>\",\n        \"amount\": 123,\n        \"adjustment_type\": \"charge\"\n      }\n    ]\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"nickname\": \"<string>\",\n  \"billing_information_attributes\": {\n    \"token\": \"<string>\",\n    \"company_name\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"address_line_1\": \"<string>\",\n    \"address_line_2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"billing_email\": [\n      \"<string>\"\n    ]\n  },\n  \"business_information_attributes\": {\n    \"token\": \"<string>\",\n    \"metadata\": {\n      \"custom_fields\": [\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"banking_information_attributes\": {\n    \"token\": \"<string>\",\n    \"bank_name\": \"<string>\",\n    \"beneficiary_name\": \"<string>\",\n    \"tax_id\": \"<string>\",\n    \"secure_data\": {\n      \"account_number\": \"<string>\",\n      \"routing_number\": \"<string>\",\n      \"iban\": \"<string>\",\n      \"swift_bic\": \"<string>\"\n    }\n  },\n  \"invoice_adjustment_attributes\": {\n    \"token\": \"<string>\",\n    \"adjustment_items\": [\n      {\n        \"name\": \"<string>\",\n        \"amount\": 123,\n        \"adjustment_type\": \"charge\"\n      }\n    ]\n  }\n}"

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.

Body

application/json

Create a billing profile (MSP invoicing required).

​
nickname
string
required

Display name for the billing profile

​
billing_information_attributes
object

Billing address and contact information

​
business_information_attributes
object

Business information and custom fields

​
banking_information_attributes
object

Banking details (MSP accounts only)

​
invoice_adjustment_attributes
object

Invoice adjustments (taxes, fees, etc.)

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