Skip to main content
The account endpoints expose the customer organization behind your storefront. Use them to read your current account context, list the accounts you can switch into, provision and remove child accounts under your org, set the registered organization domain, control domain auto-join, and manage your notification opt-ins. All examples use the storefront base URL: 
https://api.interchange.io/api/v2/storefront
Authenticate every request with Authorization: Bearer $SCOPE3_API_KEY. Your account context is resolved from the API key. Child-account, domain, and membership operations require the ADMIN role on the target customer.

​
Key concepts

  • Parent/child hierarchy. A standalone customer becomes a parent the first time you create a child account; the child inherits the parent’s contract. Only CHILD customers can be deleted, and only when they have no linked resources.
  • Registered domain. A customer can carry one customerDomain. It gates domain auto-join and, for SELLER accounts, seeds the auto-created storefront’s publisher and operator domain.
  • Domain auto-join. When allowDomainAutoJoin is true, users with a verified matching-domain email join as members without admin approval. It requires a customerDomain to be set.
  • Notification opt-ins. Preferences are a full set of { notificationType, channel } pairs. The update call replaces all existing opt-ins.

​
Task reference

Get current account

Authenticated account context

List customer accounts

Accounts you can switch into

Create child account

Provision a buyer or seller child

Delete child account

Hard-delete an empty child

Update customer domain

Set the registered org domain

Get membership

Read domain auto-join setting

Update membership

Toggle domain auto-join

Get notification preferences

Read your opt-ins

Update notification preferences

Replace your opt-ins

All account tasks

Every operation in one place

Activity & reporting

Audit feed and reporting metrics

Errors

Shared error contract