Overview
Organizations represent businesses and companies associated with your customers. They enable B2B management — group customers by company, view aggregate invoice analytics, and process batch payments.
How It Works
- Create an organization - Define a company or institution
- Assign customers - Link customers to the organization via their
organization_id - View analytics - See customer counts, invoice totals, and outstanding balances per organization
- Batch operations - Pay multiple invoices at once for an organization
Example: A university subscribes 50 staff members. Create an "State University" organization, assign all staff as customers, then use the analytics endpoint to see total outstanding invoices across all staff. Use batch pay to settle them all with one check.
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | List organizations | Retrieve a paginated list with analytics |
Important Behaviors
- Account scoping: Organizations are scoped by account. An organization from one account is invisible to another.
- List includes analytics: The list endpoint includes
customers_count,invoices_count,open_invoices_count, andtotal_net_due_by_currencyper organization.
Organization Object
| Attribute | Type | Description |
|---|---|---|
id | integer | Unique identifier |
name | string | Organization name |
customers_count | integer | Number of customers (conditional, included on list/show) |
invoices_count | integer | Total invoices across customers (conditional, list only) |
open_invoices_count | integer | Open invoices count (conditional, list only) |
total_net_due_by_currency | object | Outstanding amounts keyed by currency (conditional, list only) |
created_at | integer | Unix timestamp of creation |
updated_at | integer | Unix timestamp of last update |