Create Credit Account
Creates a credit account for the specified client
Creates a credit account for the specified client.
POST
https://example.thoughtindustries.com/incoming/v2/clients/:id/creditAccountsExample request
curl -X POST "https://example.thoughtindustries.com/incoming/v2/clients/:id/creditAccounts" \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"batchDaysUntilExpire": 0,
"clientId": "00000000-0000-0000-0000-000000000000",
"startingBalance": 0,
"minimumBatchAmount": 0
}'Parameters
| Name | Type | Required | Location | Description |
|---|---|---|---|---|
id | string | Yes | path | The id identifier. |
batchDaysUntilExpire | integer | No | body | Number of days until a credit batch expires after being issued. |
clientId | uuid | No | body | Unique identifier of the client to associate with this credit account. |
startingBalance | number | Yes | body | Initial credit balance assigned to the account at creation. |
minimumBatchAmount | integer | No | body | Minimum number of credits that must be included in a single credit batch. |
notifyEmails | string[] | Yes | body | List of email addresses to notify when account activity occurs (e.g. low balance). |
type | CreditAccountType | No | body | Classification of the credit account (e.g. client). |
name | string | Yes | body | Display name for the credit account. |
creditBatchName | string | No | body | Label applied to credit batches issued under this account. |
licenseIds | string[] | Yes | body | List of license IDs to associate with this credit account. |
Example response
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string"
}Response fields
| Field | Type | Description |
|---|---|---|
id | uuid | Identifier of the created credit account. |
name | string | Name of the credit account. |