Skip to main content
GET
/
v1
/
{tenantUUID}
Get Single Tenant information
curl --request GET \
  --url https://apigw.ipxo.com/billing/v1/{tenantUUID} \
  --header 'Authorization: Bearer <token>'
{
  "uuid": "string",
  "title": "string",
  "email": "string",
  "business_since": "string",
  "company_size": "string",
  "address1": "string",
  "address2": "string",
  "city": "string",
  "postcode": "string",
  "country": "string",
  "state": "string",
  "status": "string",
  "abuse_email": "string",
  "created_at": 0,
  "options": [
    {
      "key": "string",
      "value": {}
    }
  ],
  "meta": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "industry": {
    "uuid": "string",
    "name": 0
  },
  "credit": {
    "uuid": "string",
    "amount": 0,
    "auto_payment": true
  },
  "summary": "string",
  "logo": {
    "image": "string"
  },
  "payment_gateways": [
    "string"
  ],
  "flags": [
    {
      "uuid": "string",
      "slug": "string"
    }
  ],
  "status_reason": {
    "uuid": "string",
    "slug": "string",
    "title": "string"
  },
  "vat_number": "string",
  "vat_validated_at": "string",
  "vat_validation_status": "valid"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
tenantUUID
string
required

UUID

Pattern: ^[a-zA-Z0-9]{8}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{12}$

Response

Tenant

​
uuid
string
​
title
string
​
email
string
​
business_since
string | null
​
company_size
string | null
​
address1
string
​
address2
string
​
city
string
​
postcode
string
​
country
string
​
state
string
​
status
string
​
abuse_email
string
​
created_at
integer
​
options
object[]
​
meta
object[]
​
industry
object
​
credit
object
​
summary
string
​
payment_gateways
string[]
​
flags
object[]
​
status_reason
object
​
vat_number
string
​
vat_validated_at
string | null
​
vat_validation_status
enum<string> | null
Available options:
valid,
invalid,
failed