Get Sub-Account Details🔗︎

HTTP Verb	Path
GET	https://api.us.textkernel.com/tx/accounts/api/(accountId)

Get details for a given Sub-Account.

Path Parameters🔗︎

Parameter	Data Type	Description
accountId	string	The AccountId of the Sub-Account to get details for.

Response Body🔗︎

AccountId 🔗︎ string

AccountId🔗︎

The AccountId of the Sub-Account.

ServiceKey 🔗︎ string

ServiceKey🔗︎

The ServiceKey of the Sub-Account.

AccountName 🔗︎ string

AccountName🔗︎

The name of the Sub-Account.

Region 🔗︎ string

Region🔗︎

The Textkernel Data Center the Sub-Account belongs to.

MatchingEnabled 🔗︎ bool

MatchingEnabled🔗︎

If Search & Match is enabled on the Sub-Account.

Active 🔗︎ bool

Active🔗︎

The Sub-Account's status.

Unrestricted 🔗︎ bool

Unrestricted🔗︎

Whether or not the account has unrestricted access to your SaaS Credits.

CreditsRemaining 🔗︎ decimal

CreditsRemaining🔗︎

Credits the Sub-Account has remaining of what's been allocated. When these run out, the account will lose service. This is only output if the account is not Unrestricted.

Sample JSON

{
  "AccountId": "string",
  "ServiceKey": "string",
  "AccountName": "string",
  "Region": "string",
  "MatchingEnabled": false,
  "Active": true,
  "Unrestricted": false,
  "CreditsRemaining": 0
}