Business Profiles API

Business profiles represent your company or seller entity on invoices. When creating a managed invoice, you reference a business profile by ID to populate the seller details.

Create Business Profile

POST /api/v1/business-profiles

Request:

{
  "legal_name": "Acme Corp Inc.",
  "display_name": "Acme Corp",
  "email": "billing@acme.com",
  "phone": "+1-555-123-4567",
  "website": "https://acme.com",
  "tax_id": "US-EIN-12-3456789",
  "address": {
    "line1": "1 Main St",
    "line2": "Suite 200",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "US"
  },
  "default_currency": "USD",
  "default_locale": "en-US",
  "default_timezone": "America/New_York",
  "logo_file_id": "fil_01ABC"
}

Field	Required	Description
legal_name	Yes	Legal entity name
display_name	No	Shorter name shown on invoices
email	No	Contact email
phone	No	Contact phone number
website	No	Company website URL
tax_id	No	Tax identification number (EIN, VAT number, etc.)
address	No	Company address (see Address fields below)
default_currency	No	Default ISO 4217 currency code
default_locale	No	Default locale (e.g. en-US)
default_timezone	No	Default timezone (e.g. America/New_York)
logo_file_id	No	File ID from the Files API

Response:

{
  "data": {
    "id": "biz_01ABC",
    "legal_name": "Acme Corp Inc.",
    "display_name": "Acme Corp",
    "email": "billing@acme.com",
    "phone": "+1-555-123-4567",
    "website": "https://acme.com",
    "tax_id": "US-EIN-12-3456789",
    "address": {
      "line1": "1 Main St",
      "line2": "Suite 200",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94105",
      "country": "US"
    },
    "default_currency": "USD",
    "default_locale": "en-US",
    "default_timezone": "America/New_York",
    "logo_file_id": "fil_01ABC",
    "created_at": "2026-07-20T10:00:00Z",
    "updated_at": "2026-07-20T10:00:00Z"
  }
}

Adding a logo

1. Upload your logo: POST /api/v1/files with the image file
2. Note the returned id (e.g. fil_01ABC)
3. Set logo_file_id on your business profile
4. The logo will automatically appear on all invoices rendered with this profile

Try it

List Business Profiles

GET /api/v1/business-profiles?limit=25

Response:

{
  "data": [
    {
      "id": "biz_01ABC",
      "legal_name": "Acme Corp Inc.",
      "display_name": "Acme Corp",
      "email": "billing@acme.com",
      "created_at": "2026-07-20T10:00:00Z",
      "updated_at": "2026-07-20T10:00:00Z"
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null
  }
}

Try it

Get Business Profile

GET /api/v1/business-profiles/{id}

Fetch a single business profile (your seller identity) by ID, including its address and rendering defaults. Returns 404 not_found if it doesn't exist.

Response:

{
  "data": {
    "id": "biz_01ABC",
    "legal_name": "Acme Corp Inc.",
    "display_name": "Acme Corp",
    "email": "billing@acme.com",
    "phone": "+1-555-123-4567",
    "website": "https://acme.com",
    "tax_id": "US-EIN-12-3456789",
    "address": {
      "line1": "1 Main St", "line2": "Suite 200", "city": "San Francisco",
      "state": "CA", "postal_code": "94105", "country": "US"
    },
    "default_currency": "USD",
    "default_locale": "en-US",
    "default_timezone": "America/New_York",
    "logo_file_id": "fil_01ABC",
    "created_at": "2026-07-20T10:00:00Z",
    "updated_at": "2026-07-20T10:00:00Z"
  }
}

Try it

Update Business Profile

PATCH /api/v1/business-profiles/{id}

Only include the fields you want to change:

{
  "phone": "+1-555-999-0000",
  "address": {
    "line1": "2 Market St",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "US"
  }
}

Try it

Delete Business Profile

DELETE /api/v1/business-profiles/{id}

Response:

{
  "data": {
    "deleted": true
  }
}

Try it

Address Fields

Field	Required	Description
line1	Yes	Street address
line2	No	Suite, floor, building
city	No	City
state	No	State, province, or region
postal_code	No	ZIP or postal code
country	No	ISO 3166-1 alpha-2 country code