SaaSFlow
DevelopersAPIReferencecustomers

Create customer

Create a customer. domains are the email or web domains used to match incoming payments to this customer automatically.

Authentication

Checking whether you're signed in…
POST
/companies/{companyId}/customers

Authorization

headerAuthorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

Path Parameters

companyId*string
Length1 <= length

Request Body

application/json
  1. body
name*string
Length1 <= length
defaultCategorization?|null
domains?array<string>
logo*boolean
countryCode?string|null

Response Body

Created customer

application/json
  1. response
id*string
Formatuuid
companyId*string
Formatuuid
name*string

The name of the customer.

nameManuallyEdited*boolean

Whether the name is protected from integration updates after a manual rename.

defaultCategorization*|

The default categorization to apply to transactions from this customer.

domains*array<string>

An array of website domains associated with this customer.

logo*boolean

Flag indicating if a logo is available for this customer.

autoCreatedSource*|

The source from which this customer was automatically created.

Value in"searchApiGoogleWebSearch""stripe""hubspot""datevPayroll""finway""pleo""digistore24""paypal"null
countryCode*|

ISO 3166-1 alpha-2 country code (e.g., US, DE, GB).

createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
externalIds*array<string>

External IDs (URNs) linked to this customer (e.g., Stripe, HubSpot).

curl -X POST "https://example.com/companies/string/customers" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "logo": true  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "name": "string",  "nameManuallyEdited": true,  "defaultCategorization": {    "categoryId": "string",    "usingDateRule": {      "type": "transactionDate"    },    "plSplit": {      "revenue": 0,      "cogs": 0,      "cac": 0,      "pd": 0,      "ga": 0,      "no": 0,      "neutral": 0    },    "passThroughTax": 0,    "transferTargetAccountId": "string"  },  "domains": [    "string"  ],  "logo": true,  "autoCreatedSource": "searchApiGoogleWebSearch",  "countryCode": "string",  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string",  "externalIds": [    "string"  ]}

List customers

List customers, each enriched with its transaction count (nrTransactions), the date of its latest settled transaction (lastTransactionDate, null when there…

Linked systems

The integrations at least one customer is linked to, as the values the list endpoint accepts for linkedTo (e.g. ["digistore24", "stripe"]). Empty when no…