Skip to main content
GET
/
billing_profiles
Get all billing profiles
curl --request GET \
  --url https://api.vantage.sh/v2/billing_profiles \
  --header 'Authorization: Bearer <token>'
{
  "links": {},
  "billing_profiles": [
    {
      "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.

Query Parameters

page
integer<int32>

The page of results to return.

limit
integer<int32>

The amount of results to return. The maximum is 1000.

Response

200 - application/json

BillingProfiles model

billing_profiles
object[]