Configuration APIBilling Entities

Get a billing entity

Requires the BILLING_ENTITY.VIEW permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1
version
resourceIdOrReferencestringRequiredDefaults to
The ID or reference of the resource.

Headers

x-platform-idstringOptional
Platform ID.

Response

OK
object_typestring or nullRead-only
idstring or nullRead-only
created_atstring or nullRead-only
referencestringformat: "^\S+$"0-256 characters
statusstring or null
timezonestring or null
legal_namestring or null
The legal name of the billing entity.
tax_idstring or nullformat: "^[a-zA-Z0-9\-]*"0-256 characters
The ID used for tax purposes of the billing entity.
tax_idslist of objects or null
Tax IDs used for tax purposes of the billing entity
registration_numberstring or null
The registration number of the billing entity.
registered_addressobject
The address associated with the billing entity.
emailstring or nullformat: "(\S*@\S*\..*)"0-256 characters
The email address of the billing entity.
tax_settingsobject
Customise tax settings for this Billing Entity
tax_registrationslist of objects or null
Extra tax registrations for this billing entity
custom_fieldslist of objects or null
default_customer_country_selectorlist of enums or null
default_billing_currency_selectorlist of enums or null
linked_integrationslist of objects or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error