GetAccountPlanState - Amazon Billing and Cost Management
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

GetAccountPlanState

This returns all of the information related to the state of the account plan related to Free Tier.

Response Syntax

{ "accountId": "string", "accountPlanExpirationDate": "string", "accountPlanRemainingCredits": { "amount": number, "unit": "string" }, "accountPlanStatus": "string", "accountPlanType": "string" }

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.

accountId

A unique identifier that identifies the account.

Type: String

Pattern: [0-9]{12}

accountPlanExpirationDate

The timestamp for when the current account plan expires.

Type: Timestamp

accountPlanRemainingCredits

The amount of credits remaining for the account.

Type: MonetaryAmount object

accountPlanStatus

The current status for the account plan.

Type: String

Valid Values: NOT_STARTED | ACTIVE | EXPIRED

accountPlanType

The plan type for the account.

Type: String

Valid Values: FREE | PAID

Errors

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

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

An unexpected error occurred during the processing of your request.

HTTP Status Code: 500

ResourceNotFoundException

This exception is thrown when the requested resource cannot be found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an Amazon Web Services service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: