Update media billing entity (admin)

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

import requests

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

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

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

print(response.text)

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

fetch('https://api.interchange.io/api/v2/billing/media-entities/{entityId}', 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": {}
  }
}

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

PUT

billing

media-entities

{entityId}

Update media billing entity (admin)

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

import requests

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

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

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

print(response.text)

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

fetch('https://api.interchange.io/api/v2/billing/media-entities/{entityId}', 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": {}
  }
}

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

Authorizations

Authorization

string

header

required

API key or access token

Path Parameters

entityId

required

Surrogate id of the media billing entity.

Body

application/json

Update fields on an existing media billing entity.

entityName

string

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

Required string length: 1 - 255

countryCode

string

Stored country identity metadata for the billing entity, as an ISO 3166-1 alpha-2 code. It does not derive currency, tax/address behavior, or resolution.

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

Example:

"US"

currency

string

ISO 4217 currency code

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

Example:

"USD"

billingEmails

string<email>[]

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

Entity street address, line 1.

Required string length: 1 - 255

addressLine2

string

Entity street address, line 2 (optional).

Maximum string length: 255

city

string

Entity city.

Required string length: 1 - 128

state

string

Entity state/province/region (optional).

Maximum string length: 128

postalCode

string

Entity postal/ZIP code.

Required string length: 1 - 32

taxId

string

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

Maximum string length: 64

isPrimary

boolean

Set true to promote this entity to PRIMARY (demoting any other primary entity in the same transaction), or false to demote it. Demoting the current primary is refused unless another entity is promoted in its place — an org always has exactly one primary once it has any entity.

Response

Update media billing entity (admin)

entity

object

required

A media billing configuration entity used by resolution previews. The invoice producer does not consume it yet.

Show child attributes

Start building

Core Concepts

Buyer operations

Seller operations

Cross-Cutting Reference

Buyer API reference

Seller API reference

Release Notes

Update media billing entity (admin)

Authorizations

Path Parameters

Body

Response