- Docs
- API reference
- Endpoints and schemas
- GraphQL
- Selection
Account
The billing account of the organization that sends the request.
Selection. This type is a selection. An intent returns it, and you choose which of its fields come back.
The billing account of the organization that sends the request. Use the account query to read the pricing plan, the credit status, and the auto-recharge settings. Auto-recharge buys credits automatically when the credit balance falls below a threshold.
Where it appears
Section titled “Where it appears”No connection leads here from a primary entity.
accountreturns it.
Fields
Section titled “Fields”| Field | Type | Description |
|---|---|---|
customerId |
ID |
The ID of the organization that owns the billing account. |
customerEmail |
String |
The email address of the owner of the account. |
billingAccountId |
ID |
The ID of the billing account. |
pricingPlan |
String |
The name of the pricing plan of the billing account. |
creditsAvailable |
Boolean |
Whether the billing account has credits available. When this value is false, a request that uses credits fails with an insufficient credits error. |
autoRenewEnabled |
Boolean |
Whether the payment plan renews automatically at the start of the next pay period. |
autoRechargeDesiredState |
Boolean |
Whether the account owner turned on auto-recharge. Compare with autoRechargeCurrentState, which shows whether auto-recharge is active now. |
autoRechargeCurrentState |
Boolean |
Whether auto-recharge is active now. Enigma turns auto-recharge off when the next recharge would go above autoRechargeLimitUsd for the pay period. Enigma turns it on again in a later pay period. |
autoRechargeThresholdAmount |
Int |
The credit balance that starts a recharge. When the balance falls below this number of credits, auto-recharge buys more credits. |
autoRechargeRechargeToAmount |
Int |
The credit balance, in credits, that a recharge fills the account to. |
autoRechargeLimitUsd |
Int |
The maximum amount, in US dollars, that auto-recharge can spend in one pay period. |
autoRechargeReenableAfterTimestamp |
String |
The date and time after which Enigma can turn auto-recharge on again. Enigma sets it to the end of the pay period when auto-recharge stops at the spend limit. |
Example
Section titled “Example”query { account { customerId customerEmail billingAccountId pricingPlan }}Response, as returned:
{ "data": { "account": { "customerId": "00000000-0000-4000-8000-000000000001", "customerEmail": "user@example.com", "billingAccountId": "00000000-0000-4000-8000-000000000002", "pricingPlan": "ENTERPRISE" } }}