> For the complete documentation index, see [llms.txt](https://faq.droam.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://faq.droam.com/menu/webhooks/webhook-payload-models/sim-card-model.md).

# SIM Card Model

The SIM Card Model – is a base model for show platform SIM card parameters. Model fields are presented in the table (Table 4.9), with an example below (Listing 4.7). There are the following types of this model (Table 4.10).&#x20;

**Table 4.9 – Fields of SIM Card Model**&#x20;

<table><thead><tr><th width="67">№</th><th width="141">Key </th><th width="113">Type </th><th width="107">Exists </th><th>Description </th></tr></thead><tbody><tr><td>1</td><td>iccid </td><td>string </td><td>required </td><td>Identifier of SIM Card</td></tr><tr><td>2</td><td>sim_card_type</td><td>string </td><td>optional</td><td>Type of SIM, if it exists</td></tr><tr><td>3</td><td>msisdn </td><td>string </td><td>optional</td><td>Identifier of SIM line</td></tr><tr><td>4</td><td>imei </td><td>string </td><td>optional</td><td>Identifier of SIM device, if it exists</td></tr><tr><td>5</td><td>is_e_sim</td><td>boolean </td><td>optional</td><td>Shows whether it is an eSIM card </td></tr><tr><td>6</td><td>status </td><td>Status Model</td><td>optional</td><td>Current SIM Card status</td></tr><tr><td>7</td><td>plan </td><td>Plan Model</td><td>optional</td><td>SIM Plan, if it exists</td></tr><tr><td>8</td><td>company </td><td>Account Model</td><td>optional</td><td>Assigned SIM Company </td></tr><tr><td>9</td><td>end_user</td><td>Account Model</td><td>optional</td><td>Assigned SIM End User</td></tr><tr><td>10</td><td>details </td><td>array </td><td>optional</td><td>Details about SIM Card like usage, etc. </td></tr></tbody></table>

**Listing 4.7 – Example of SIM Card Model (JSON)**&#x20;

<pre><code>{ 
<strong>    "iccid":            "8920000012345678900", 
</strong><strong>    "sim_card_type":    "prepaid", 
</strong>    "msisdn":           "01234567890", 
    "imei":             "86-000000-111111-2", 
    "is_e_sim":         false, 
    "status":           {...//Status Model}, 
    "plan":             {...//Plan Model}, 
    "company":          {...//Account Model}, 
    "end_user":         {...//End User Model}, 
    "details":          ["current_usage_kb" => 512, ...] 
}
</code></pre>

**Table 4.10 – Sim Card Types**&#x20;

<table><thead><tr><th width="75">№</th><th width="193">Title </th><th>Description </th></tr></thead><tbody><tr><td>1</td><td>Prepaid </td><td>SIM Card with Prepaid Plan</td></tr><tr><td>2</td><td>Subscription </td><td>SIM Card with one of Subscription Plans </td></tr><tr><td>3</td><td>PAYGO </td><td>SIM Card with PAYGO Plan</td></tr><tr><td>4</td><td>Without Type</td><td>Blank SIM Card. May be unavailable</td></tr></tbody></table>
