Update billing information (admin)

curl --request PUT \
  --url https://api.interchange.io/api/v2/buyer/billing/info \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactName": "<string>",
  "email": [
    "jsmith@example.com"
  ],
  "ccEmails": [
    "jsmith@example.com"
  ],
  "phone": "<string>",
  "address": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "region": "<string>",
  "postalCode": "<string>",
  "countryAlpha2": "US",
  "taxId": "<string>"
}
'

import requests

url = "https://api.interchange.io/api/v2/buyer/billing/info"

payload = {
    "contactName": "<string>",
    "email": ["jsmith@example.com"],
    "ccEmails": ["jsmith@example.com"],
    "phone": "<string>",
    "address": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "countryAlpha2": "US",
    "taxId": "<string>"
}
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({
    contactName: '<string>',
    email: ['jsmith@example.com'],
    ccEmails: ['jsmith@example.com'],
    phone: '<string>',
    address: '<string>',
    address2: '<string>',
    city: '<string>',
    region: '<string>',
    postalCode: '<string>',
    countryAlpha2: 'US',
    taxId: '<string>'
  })
};

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

{
  "billingInfo": {
    "contactName": "<string>",
    "email": [
      "<string>"
    ],
    "ccEmails": [
      "<string>"
    ],
    "phone": "<string>",
    "address": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "countryAlpha2": "<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": {}
  }
}

PUT

billing

info

Update billing information (admin)

curl --request PUT \
  --url https://api.interchange.io/api/v2/buyer/billing/info \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactName": "<string>",
  "email": [
    "jsmith@example.com"
  ],
  "ccEmails": [
    "jsmith@example.com"
  ],
  "phone": "<string>",
  "address": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "region": "<string>",
  "postalCode": "<string>",
  "countryAlpha2": "US",
  "taxId": "<string>"
}
'

import requests

url = "https://api.interchange.io/api/v2/buyer/billing/info"

payload = {
    "contactName": "<string>",
    "email": ["jsmith@example.com"],
    "ccEmails": ["jsmith@example.com"],
    "phone": "<string>",
    "address": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "countryAlpha2": "US",
    "taxId": "<string>"
}
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({
    contactName: '<string>',
    email: ['jsmith@example.com'],
    ccEmails: ['jsmith@example.com'],
    phone: '<string>',
    address: '<string>',
    address2: '<string>',
    city: '<string>',
    region: '<string>',
    postalCode: '<string>',
    countryAlpha2: 'US',
    taxId: '<string>'
  })
};

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

{
  "billingInfo": {
    "contactName": "<string>",
    "email": [
      "<string>"
    ],
    "ccEmails": [
      "<string>"
    ],
    "phone": "<string>",
    "address": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "countryAlpha2": "<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": {}
  }
}

Authorizations

Authorization

string

header

required

API key or access token

Body

application/json

contactName

string | null

Billing contact / payer name

Required string length: 1 - 255

string<email>[] | null

Email addresses invoices are sent to

Maximum array length: 10

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

ccEmails

string<email>[] | null

Email addresses CC’d on invoices

Maximum array length: 10

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

phone

string | null

Billing phone number

Maximum string length: 64

address

string | null

Billing street address, line 1

Maximum string length: 255

address2

string | null

Billing street address, line 2

Maximum string length: 255

city

string | null

Billing city

Maximum string length: 128

region

string | null

Billing state/province/region

Maximum string length: 128

postalCode

string | null

Billing postal/ZIP code

Maximum string length: 32

countryAlpha2

string | null

Billing country (ISO 3166-1 alpha-2)

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

Example:

"US"

taxId

string | null

Tax/VAT identifier shown on invoices

Maximum string length: 64

Response

Update billing information (admin)

billingInfo

object

required

Billing (payer) information for the authenticated customer, used on manually issued invoices.

Show child attributes

Get billing information Get billing account

⌘I