Skip to main content
PUT
/
billing_profiles
/
{billing_profile_token}
Update billing profile
curl --request PUT \
  --url https://api.vantage.sh/v2/billing_profiles/{billing_profile_token} \
  --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>"
        }
      ]
    }
  },
  "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>",
      "adjustment_type": "charge",
      "calculation_type": "fixed",
      "amount": "<string>"
    }
  },
  "managed_accounts_count": "<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

Body

application/json

Update a billing profile (MSP invoicing required).

​
nickname
string

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
​
nickname
string

Display name for the billing profile

​
created_at
string

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

Example:

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

​
updated_at
string

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
​
business_information_attributes
object
​
banking_information_attributes
object
​
invoice_adjustment_attributes
object
​
managed_accounts_count
string

Number of managed accounts using this billing profile