Skip to main content
GET /api/v2/billing/info Returns the billing (payer) info on file for the authenticated account — the contact, delivery emails, address, and tax ID Scope3 uses when issuing your invoices. No payment processing happens through this API; it is collected information only. Check it before your first invoice cycle: an invoice needs at least a payer name and payer address.

​
Request

curl
curl "https://api.interchange.io/api/v2/billing/info" \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

​
Parameters

This endpoint takes no parameters.

​
Response

{
  "billingInfo": {
    "contactName": "Dana Whitfield",
    "email": ["ap@bluepeakbrands.example"],
    "ccEmails": ["finance@bluepeakbrands.example"],
    "phone": "+1 415 555 0182",
    "address": "225 Mission St",
    "address2": "Floor 8",
    "city": "San Francisco",
    "region": "CA",
    "postalCode": "94105",
    "countryAlpha2": "US",
    "taxId": "83-1234567"
  }
}
FieldTypeNotes
contactNamestring | nullBilling contact / payer name — who the invoice is addressed to
emailarrayEmail addresses invoices are sent to
ccEmailsarrayEmail addresses CC’d on invoices
phonestring | nullBilling phone number
addressstring | nullBilling street address, line 1
address2string | nullBilling street address, line 2
citystring | nullBilling city
regionstring | nullState/province/region
postalCodestring | nullPostal/ZIP code
countryAlpha2string | nullBilling country (ISO 3166-1 alpha-2)
taxIdstring | nullTax/VAT identifier shown on invoices
Fields are null (emails: empty) until set with Update billing info.

​
Errors

  • 401 UNAUTHORIZED — missing or invalid bearer token.
See Errors for the full error contract.

Update billing info

Change the details on file

Billing overview

How invoicing and remittance work