get-billing-explainer-per-payer
dci get-billing-explainer-per-payer invoiceMonth
Returns the invoiced cost changes for each payer in the authenticated tenant.
Output
Billing explainer returned.
By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.
| Field | Type | Description |
|---|---|---|
customerId | string | |
invoiceMonth | string | |
updateTime | string (date-time) | |
payers | map of object | |
payers.*.payerId | string | |
payers.*.friendlyName | string | |
payers.*.summary | object | |
payers.*.summary.aws | object | Nested fields omitted — see the raw JSON schema. |
payers.*.summary.doit | object | Nested fields omitted — see the raw JSON schema. |
payers.*.summary.awsWithoutDoit | object | Nested fields omitted — see the raw JSON schema. |
payers.*.service | map of object | |
payers.*.service.*.doit | map of object | Nested fields omitted — see the raw JSON schema. |
payers.*.service.*.aws | map of object | Nested fields omitted — see the raw JSON schema. |
payers.*.account | map of object | |
payers.*.account.*.doit | map of object | Nested fields omitted — see the raw JSON schema. |
payers.*.account.*.aws | map of object | Nested fields omitted — see the raw JSON schema. |
doitCredits | object | Monetary value represented as a decimal string and an ISO 4217 currency code. |
doitCredits.amount | string | Decimal amount serialized at the currency's minor-unit precision. |
doitCredits.currency | string | ISO 4217 three-letter uppercase currency code. |
invoiceAdjustments | object | Monetary value represented as a decimal string and an ISO 4217 currency code. |
invoiceAdjustments.amount | string | Decimal amount serialized at the currency's minor-unit precision. |
invoiceAdjustments.currency | string | ISO 4217 three-letter uppercase currency code. |
Raw JSON schema
{
"type": "object",
"additionalProperties": false,
"required": [
"customerId",
"invoiceMonth",
"updateTime",
"payers",
"doitCredits",
"invoiceAdjustments"
],
"properties": {
"customerId": {
"type": "string"
},
"invoiceMonth": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])$"
},
"updateTime": {
"type": "string",
"format": "date-time"
},
"payers": {
"type": "object",
"additionalProperties": {
"allOf": [
{
"type": "object",
"required": [
"summary",
"service",
"account"
],
"properties": {
"summary": {
"type": "object",
"additionalProperties": false,
"required": [
"aws",
"doit",
"awsWithoutDoit"
],
"properties": {
"aws": {
"type": "object",
"additionalProperties": false,
"required": [
"serviceCharges",
"discounts",
"tax",
"supportCharges",
"credits",
"savings",
"otherCharges",
"refunds",
"total"
],
"properties": {
"serviceCharges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"discounts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"tax": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"supportCharges": {
"type": "object",
"additionalProperties": false,
"required": [
"cost",
"details"
],
"properties": {
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
},
"details": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"projectId",
"serviceDescription",
"description",
"cost",
"baseCost"
],
"properties": {
"projectId": {
"type": "string"
},
"serviceDescription": {
"type": "string"
},
"description": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
},
"baseCost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
}
}
},
"credits": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"savings": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"otherCharges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"refunds": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"total": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
},
"doit": {
"type": "object",
"additionalProperties": false,
"required": [
"serviceCharges",
"discounts",
"tax",
"supportCharges",
"credits",
"savings",
"otherCharges",
"refunds",
"total"
],
"properties": {
"serviceCharges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"discounts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"tax": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"supportCharges": {
"type": "object",
"additionalProperties": false,
"required": [
"cost",
"details"
],
"properties": {
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
},
"details": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"projectId",
"serviceDescription",
"description",
"cost",
"baseCost"
],
"properties": {
"projectId": {
"type": "string"
},
"serviceDescription": {
"type": "string"
},
"description": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
},
"baseCost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
}
}
},
"credits": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"savings": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"otherCharges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"refunds": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"total": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
},
"awsWithoutDoit": {
"type": "object",
"additionalProperties": false,
"required": [
"serviceCharges",
"discounts",
"tax",
"supportCharges",
"credits",
"savings",
"otherCharges",
"refunds",
"total"
],
"properties": {
"serviceCharges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"discounts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"tax": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"supportCharges": {
"type": "object",
"additionalProperties": false,
"required": [
"cost",
"details"
],
"properties": {
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
},
"details": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"projectId",
"serviceDescription",
"description",
"cost",
"baseCost"
],
"properties": {
"projectId": {
"type": "string"
},
"serviceDescription": {
"type": "string"
},
"description": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
},
"baseCost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
}
}
},
"credits": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"savings": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"otherCharges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"refunds": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"total": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
}
},
"service": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"required": [
"doit",
"aws"
],
"properties": {
"doit": {
"type": "object",
"additionalProperties": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
},
"aws": {
"type": "object",
"additionalProperties": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
}
},
"account": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"required": [
"doit",
"aws"
],
"properties": {
"doit": {
"type": "object",
"additionalProperties": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
},
"aws": {
"type": "object",
"additionalProperties": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
}
}
}
},
{
"type": "object",
"required": [
"payerId",
"friendlyName"
],
"properties": {
"payerId": {
"type": "string"
},
"friendlyName": {
"type": "string"
}
}
}
]
}
},
"doitCredits": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
},
"invoiceAdjustments": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
Errors
On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.
| HTTP status | Exit code | Error code | Meaning |
|---|---|---|---|
| 400 | 30 | VALIDATION_ERROR | The arguments or request body were rejected. Review the command's flags and payload. |
| 401 | 10 | AUTHENTICATION_FAILED | Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY. |
| 403 | 11 | PERMISSION_DENIED | The DoiT user or the active customer context does not have access. |
| 404 | 20 | RESOURCE_NOT_FOUND | The requested resource does not exist. Check the identifier argument. |
| 500 | 40 | API_SERVER_ERROR | The API failed to process the request. Retryable; contact DoiT support if it persists. |
Aliases: getbillingexplainerperpayer