Skip to content

GetCreditsRequest

Source code in docs_src/capo_billing/types/get_credits_request.py
class GetCreditsRequest(TypedDict, closed=True):
    account_id: "str"
    """<p>The Amazon Web Services account ID. Must be a 12-digit numeric string.</p>"""
    start_date: "datetime.datetime"
    """<p>The start date for the credit period as Unix epoch seconds. Must be a past date that is not more than one year before the current date.</p>"""
    end_date: NotRequired["datetime.datetime"]
    """<p>The end date for the credit period as Unix epoch seconds. Must not be a future date and must be on or after <code>startDate</code>. Defaults to the current date when omitted.</p>"""
    payer_account_flag: NotRequired["bool"]
    """<p>When <code>true</code> and the caller is the management account, the response aggregates credits across the entire consolidated billing family. When <code>false</code> or omitted, returns only credits for the specified <code>accountId</code>.</p>"""

account_id instance-attribute

account_id: str

The Amazon Web Services account ID. Must be a 12-digit numeric string.

end_date instance-attribute

end_date: NotRequired[datetime]

The end date for the credit period as Unix epoch seconds. Must not be a future date and must be on or after startDate. Defaults to the current date when omitted.

payer_account_flag instance-attribute

payer_account_flag: NotRequired[bool]

When true and the caller is the management account, the response aggregates credits across the entire consolidated billing family. When false or omitted, returns only credits for the specified accountId.

start_date instance-attribute

start_date: datetime

The start date for the credit period as Unix epoch seconds. Must be a past date that is not more than one year before the current date.