Retrieve a business

Get your business's profile, and where its email alerts go.

Your business's profile, and where its email alerts go. It takes a person signed in to the dashboard, never an API key.

Path

id string Required

The business's ID, such as biz_Nq4sT8vWx2Lm6Rb1.

Fields to know

status string

incomplete until setup finishes, which takes a wallet, then active.
suspended_at timestamp

Set while 402pay has suspended the business: checkout takes no new payments, though ones already open can finish.
alert_email string

Where payment alerts and the weekly summary go: your sign-in email, or another address once its code is confirmed. null means your sign-in email too.
pending_alert_email string

An address waiting for its code, or null. It gets nothing but the code until someone confirms it.
email_alerts boolean

false pauses every alert email for this business.

Errors

403 session_required

An API key sent the request. Only a person signed in to the dashboard can send.
404 not_found

You don't own a business with that ID.

Any request can also fail on its key or its body. See errors.

RequestBrowser

// On a dashboard page, whose session cookie the browser sends with credentials.
const response = await fetch("https://api.402pay.co/api/v1/businesses/biz_Nq4sT8vWx2Lm6Rb1", {
  credentials: "include",
  headers: {
    "402pay-Business": businessId,
  },
});
const { data } = await response.json();

Response200 OK

{
  "data": {
    "id": "biz_Nq4sT8vWx2Lm6Rb1",
    "kind": "business",
    "name": "Acme Studio",
    "website": "https://example.com",
    "support_email": "[email protected]",
    "alert_email": "[email protected]",
    "pending_alert_email": "[email protected]",
    "status": "active",
    "suspended_at": null,
    "email_alerts": true,
    "product_updates": false,
    "created_at": "2026-05-09T21:18:42.216Z",
    "updated_at": "2026-09-24T10:02:51.338Z"
  }
}