Accounts

The externalId parameter is meant to be used as an external reference to the system that the account is being created from, it is required if Single Sign-On is enabled where it will be used to match the incoming NameID in SAML (or Subject in OIDC) to the correct Account (more on that can be found in Single Sign On section of the documentation).If the SEPA integration is enabled for the Provider, and the sepaAccepted parameter is provided, a SEPA Direct Debit mandate email will be sent to the account's billing email.

The search for accounts is driven by an index and eventually consistent. That means that an update to accounts may take a short while before it is reflected in search results.

To access billing information for accounts (debit & credit billing), the user or credential making the API call must have the accounts-billing:read permissions.

Updates Account with partial data. When updating or modifying billing data for account objects, the calling user or credential must possess a accounts-billing:read-write permission. This permission allows the user to make changes to the billing information associated with the specific account entity.