GetCredits

Returns the list of AWS account credits for the specified account. Each credit includes its identifier, type, monetary amounts, applicable products, expiration, sharing configuration, and current enabled status.

When the caller is the management account of a consolidated billing family and payerAccountFlag is true, the response aggregates credits across the entire family. Otherwise, the response includes only credits owned by the account specified in accountId.

Request Syntax

{
   "accountId": "string",
   "endDate": number,
   "payerAccountFlag": boolean,
   "startDate": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Response Syntax

{
   "credits": [ 
      { 
         "accountHasCreditSharingEnabled": boolean,
         "accountId": "string",
         "applicableProductNames": [ "string" ],
         "applicationType": "string",
         "costCategoryArn": "string",
         "creditConsoleVisibility": "string",
         "creditId": "string",
         "creditSharingType": "string",
         "creditStatus": "string",
         "creditType": "string",
         "description": "string",
         "endDate": number,
         "estimatedAmount": { 
            "currencyAmount": "string",
            "currencyCode": "string"
         },
         "exhaustDate": number,
         "initialAmount": { 
            "currencyAmount": "string",
            "currencyCode": "string"
         },
         "purchaseTypeApplications": [ "string" ],
         "remainingAmount": { 
            "currencyAmount": "string",
            "currencyCode": "string"
         },
         "ruleName": "string",
         "shareableAccounts": [ "string" ],
         "startDate": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Errors

For information about the errors that are common to all actions, see Common Error Types.