Create media billing entity (admin)

curl --request POST \
  --url https://api.interchange.io/api/v2/billing/media-entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityName": "<string>",
  "countryCode": "US",
  "currency": "USD",
  "billingEmails": [
    "jsmith@example.com"
  ],
  "addressLine1": "<string>",
  "city": "<string>",
  "postalCode": "<string>"
}
'

import requests

url = "https://api.interchange.io/api/v2/billing/media-entities"

payload = {
    "entityName": "<string>",
    "countryCode": "US",
    "currency": "USD",
    "billingEmails": ["jsmith@example.com"],
    "addressLine1": "<string>",
    "city": "<string>",
    "postalCode": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entityName: '<string>',
    countryCode: 'US',
    currency: 'USD',
    billingEmails: ['jsmith@example.com'],
    addressLine1: '<string>',
    city: '<string>',
    postalCode: '<string>'
  })
};

fetch('https://api.interchange.io/api/v2/billing/media-entities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "entity": {
    "id": 0,
    "entityName": "<string>",
    "countryCode": "US",
    "currency": "USD",
    "billingEmails": [
      "jsmith@example.com"
    ],
    "addressLine1": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "isPrimary": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "addressLine2": "<string>",
    "state": "<string>",
    "taxId": "<string>"
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

POST

billing

media-entities

Create media billing entity (admin)

curl --request POST \
  --url https://api.interchange.io/api/v2/billing/media-entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityName": "<string>",
  "countryCode": "US",
  "currency": "USD",
  "billingEmails": [
    "jsmith@example.com"
  ],
  "addressLine1": "<string>",
  "city": "<string>",
  "postalCode": "<string>"
}
'

import requests

url = "https://api.interchange.io/api/v2/billing/media-entities"

payload = {
    "entityName": "<string>",
    "countryCode": "US",
    "currency": "USD",
    "billingEmails": ["jsmith@example.com"],
    "addressLine1": "<string>",
    "city": "<string>",
    "postalCode": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entityName: '<string>',
    countryCode: 'US',
    currency: 'USD',
    billingEmails: ['jsmith@example.com'],
    addressLine1: '<string>',
    city: '<string>',
    postalCode: '<string>'
  })
};

fetch('https://api.interchange.io/api/v2/billing/media-entities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "entity": {
    "id": 0,
    "entityName": "<string>",
    "countryCode": "US",
    "currency": "USD",
    "billingEmails": [
      "jsmith@example.com"
    ],
    "addressLine1": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "isPrimary": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "addressLine2": "<string>",
    "state": "<string>",
    "taxId": "<string>"
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

API key or access token

Body

application/json

Create a media billing entity — a legal entity Scope3 invoices for media spend.

entityName

string

required

Legal name of the media billing entity (e.g. "WPP South Africa (Pty) Ltd").

Required string length: 1 - 255

countryCode

string

required

Country of the billing entity, as an ISO 3166-1 alpha-2 code. Metadata only — drives tax treatment and bank/address formatting, never invoice routing (money-streams.md §6.4).

Pattern: ^[A-Z]{2}$

Example:

"US"

currency

string

required

ISO 4217 currency code

Pattern: ^[A-Z]{3}$

Example:

"USD"

billingEmails

string<email>[]

required

Invoicing contact email(s) for this entity. At least one is required.

Required array length: 1 - 20 elements

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

addressLine1

string

required

Entity street address, line 1.

Required string length: 1 - 255

city

string

required

Entity city.

Required string length: 1 - 128

postalCode

string

required

Entity postal/ZIP code.

Required string length: 1 - 32

addressLine2

string

Entity street address, line 2 (optional).

Maximum string length: 255

state

string

Entity state/province/region (optional).

Maximum string length: 128

taxId

string

Tax identifier for this entity (e.g. VAT number, EIN), when applicable.

Maximum string length: 64

isPrimary

boolean

Set true to make this the org's PRIMARY media billing entity (the mandatory backstop every media-transacting org must have), demoting any other primary entity. Omit to leave the current primary/non-primary status unchanged. An org's FIRST entity always becomes primary regardless of this field.

Response

Create media billing entity (admin)

entity

object

required

A media billing entity — a legal entity Scope3 invoices for media spend.

Show child attributes

List media billing entities Update media billing entity (admin)

⌘I