@akamai/openapi-ts
    Preparing search index...

    Type Alias ChildAccount

    Child account object.

    type ChildAccount = {
        active_since?: string;
        address_1?: string;
        address_2?: string;
        balance?: number;
        balance_uninvoiced?: number;
        billing_source?: "external";
        capabilities?: string[];
        city?: string;
        company?: string;
        country?: string;
        credit_card?: { expiry?: string; last_four?: string };
        email?: string;
        euuid?: string;
        first_name?: string;
        last_name?: string;
        phone?: string;
        state?: string;
        tax_id?: string;
        zip?: string;
    }
    Index

    Properties

    active_since? address_1? address_2? balance? balance_uninvoiced? billing_source? capabilities? city? company? country? credit_card? email? euuid? first_name? last_name? phone? state? tax_id? zip?

    Properties

    active_since?: string

    Read-only The activation date and time for the child account.

    address_1?: string

    Filterable First line of this child account's billing address.

    address_2?: string

    Filterable Second line of this child account's billing address, if applicable.

    balance?: number

    Read-only This child account's balance, in US dollars.

    balance_uninvoiced?: number

    Read-only This child account's current estimated invoice in US dollars. This is not your final invoice balance. Transfer charges are not included in the estimate.

    billing_source?: "external"

    Read-only The source of service charges for this account, as determined by its relationship with Akamai. The API returns a value of external to describe a child account in a parent-child account environment.

    capabilities?: string[]

    Read-only A list of the capabilities the child account supports.

    city?: string

    Filterable The city for this child account's billing address.

    company?: string

    Filterable The company name for the owner of this child account. It can't include any of these characters: < > ( ) " =. You can't change this value yourself. We use it to create the proxy users that a parent account uses to access a child account. Talk to your account team if you need to change this value.

    country?: string

    Filterable The two-letter ISO 3166 country code for this child account's billing address.

    credit_card?: { expiry?: string; last_four?: string }

    Read-only Information for the credit card you've assigned to this child account.

    Type Declaration

    • Optionalexpiry?: string

      The expiration month and year of the credit card.

    • Optionallast_four?: string

      The last four digits of the credit card.

    email?: string

    Filterable The email address of the owner of this child account.

    euuid?: string

    Read-only An external, unique identifier that Akamai assigned to the child account.

    first_name?: string

    Filterable The first name of the owner of this child account. It can't include any of these characters: < > ( ) " =.

    last_name?: string

    Filterable The last name of the owner of this child account. It can't include any of these characters: < > ( ) " =.

    phone?: string

    Filterable The phone number for the owner of this child account.

    state?: string

    Filterable The state or province for the billing address (address_1 and address_2, if applicable). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.

    📘

    If this is a US military address, use state abbreviations (AA, AE, AP).

    tax_id?: string

    The tax identification number for this child account. Use this for tax calculations in some countries. If you live in a country that doesn't collect taxes, ensure this is an empty string ("").

    zip?: string

    Filterable The zip code of this Account's billing address. The following restrictions apply:

    • Can only contain ASCII letters, numbers, and hyphens (-).
    • Can't contain more than 9 letter or number characters.

    Settings

    Member Visibility

    On This Page

    Properties