Skip to main content

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.

This page is auto-generated based on the official Terraform documentation.

Overview

Use this resource with the Vantage Terraform provider. For installation and authentication, see the Terraform provider quickstart. The schema below is generated directly from the provider source.

Example Usage

# Fetch all billing profiles
data "vantage_billing_profiles" "all_profiles" {}

# Basic billing profile with minimal configuration
resource "vantage_billing_profile" "basic_profile" {
  nickname = "Basic Company Profile Test"
}

# Billing profile with nested billing information attributes
resource "vantage_billing_profile" "complete_profile_nested" {
  nickname = "Complete Company Profile Testng"

  billing_information_attributes = {
    company_name   = "Example Corp"
    address_line_1 = "123 Business Ave"
    address_line_2 = "Suite 100"
    city           = "New York"
    state          = "NY"
    postal_code    = "10001"
    country_code   = "US"
    billing_email  = ["billing@example.com"]
  }

  banking_information_attributes = {
    beneficiary_name = "John Doe"
    bank_name        = "Example Bank"
  }

  business_information_attributes = {
    metadata = {
      custom_fields = [
        {
          name  = "VAT"
          value = "123456789"
        }
      ]
    }
  }
}

Schema

Required

  • nickname (String) Display name for the billing profile

Optional

Read-Only

  • created_at (String) The date and time, in UTC, the billing profile was created. ISO 8601 formatted.
  • id (String) The id of the billing profile
  • managed_accounts_count (String) Number of managed accounts using this billing profile
  • token (String) The token of the billing profile
  • updated_at (String) The date and time, in UTC, the billing profile was last updated. ISO 8601 formatted.

Nested Schema for banking_information_attributes

Optional:
  • bank_name (String) Name of the bank
  • beneficiary_name (String) Name of the account beneficiary
  • secure_data (Attributes) Encrypted banking details (see below for nested schema)
  • tax_id (String) Tax identification number
  • token (String)

Nested Schema for banking_information_attributes.secure_data

Optional:
  • account_number (String) Bank account number (US)
  • iban (String) International Bank Account Number (EU)
  • routing_number (String) Bank routing number (US)
  • swift_bic (String) SWIFT/BIC code (EU)

Nested Schema for billing_information_attributes

Optional:
  • address_line_1 (String) First line of billing address
  • address_line_2 (String) Second line of billing address
  • billing_email (List of String) Array of billing email addresses
  • city (String) City for billing address
  • company_name (String) Company name for billing
  • country_code (String) ISO country code
  • postal_code (String) Postal or ZIP code
  • state (String) State or province for billing address
  • token (String)

Nested Schema for business_information_attributes

Optional:

Nested Schema for business_information_attributes.metadata

Optional:

Nested Schema for business_information_attributes.metadata.custom_fields

Optional:
  • name (String) Custom field name
  • value (String) Custom field value

Nested Schema for invoice_adjustment_attributes

Optional:

Nested Schema for invoice_adjustment_attributes.adjustment_items

Required:
  • amount (Number) Amount or percentage value
  • calculation_type (String) How the adjustment is calculated
  • name (String) Name of the adjustment
Optional:
  • adjustment_type (String) Type of adjustment