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>",
        "calculation_type": "fixed",
        "amount": 123,
        "adjustment_type": "charge"
      }
    ]
  }
}
'
{
  "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>",
        "adjustment_type": "charge",
        "calculation_type": "fixed",
        "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>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.vantage.sh/llms.txt

Use this file to discover all available pages before exploring further.

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