CreditData
Detailed information about an AWS credit, including its identifier, type, monetary amounts, applicable products, sharing configuration, and current enabled status.
Contents
- accountId
-
The AWS account ID that owns the credit.
Type: String
Pattern:
[0-9]{12}Required: Yes
- creditId
-
The unique identifier for the credit.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
[0-9]+Required: Yes
- creditType
-
The type of credit. Examples:
Promotion,Refund,TrueUp.Type: String
Required: Yes
- description
-
A human-readable description of the credit.
Type: String
Required: Yes
- initialAmount
-
The initial amount of the credit when it was issued.
Type: Amount object
Required: Yes
- remainingAmount
-
The unused balance of the credit.
Type: Amount object
Required: Yes
- startDate
-
The date the credit becomes valid, as Unix epoch seconds.
Type: Timestamp
Required: Yes
- accountHasCreditSharingEnabled
-
Whether the owning account has account-level credit sharing turned on.
Type: Boolean
Required: No
- applicableProductNames
-
The names of AWS services this credit applies to.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1000 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- applicationType
-
When the credit is applied during bill computation. Valid values:
BEFORE_CROSS_SERVICE_DISCOUNTS,AFTER_DISCOUNTS.Type: String
Valid Values:
BEFORE_CROSS_SERVICE_DISCOUNTS | AFTER_DISCOUNTSRequired: No
- costCategoryArn
-
The Amazon Resource Name (ARN) of the Cost Category controlling the credit's sharing scope. Present only when
creditSharingTypeisCOST_CATEGORY_RULE.Type: String
Required: No
- creditConsoleVisibility
-
The display configuration for the credit in the AWS Billing console.
Type: String
Required: No
- creditSharingType
-
The sharing configuration for the credit. Valid values:
DEFAULT,DISABLED,CUSTOM,COST_CATEGORY_RULE.Type: String
Valid Values:
DEFAULT | DISABLED | CUSTOM | COST_CATEGORY_RULERequired: No
- creditStatus
-
Whether the credit participates in billing runs. Valid values:
ENABLED,DISABLED.Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
- endDate
-
The date the credit expires, as Unix epoch seconds.
Type: Timestamp
Required: No
- estimatedAmount
-
The estimated remaining balance, including in-flight (open) bills that have not yet been finalized.
Type: Amount object
Required: No
- exhaustDate
-
The date the credit balance reached zero, as Unix epoch seconds.
Type: Timestamp
Required: No
- purchaseTypeApplications
-
Restricts which purchase types this credit applies to. When
nullor omitted, the credit applies to all purchase types.Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
- ruleName
-
The rule name within the Cost Category. Present only when
creditSharingTypeisCOST_CATEGORY_RULE.Type: String
Required: No
-
The AWS account IDs entitled to apply this credit.
Type: Array of strings
Pattern:
[0-9]{12}Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
