> For the complete documentation index, see [llms.txt](https://docs.2checkout.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.2checkout.com/soap-api-reference/soap-api-6.0/api-requests/customer.md).

# Customer

Use the object below to [create](/soap-api-reference/soap-api-6.0/api-requests/customer/create-customer.md), [update](/soap-api-reference/soap-api-6.0/api-requests/customer/update-customer.md) and [retrieve](/soap-api-reference/soap-api-6.0/api-requests/customer/retrieve-customer.md) customers in 2Checkout.

## Request parameters <a href="#input-parameters" id="input-parameters"></a>

<table><thead><tr><th width="248.1331787109375">Parameter</th><th>Type / Description</th></tr></thead><tbody><tr><td><code>ExternalCustomerReference</code></td><td><strong>Optional (string)</strong><br>Unique customer alphanumeric (string) identifiers you control. Aggregate subscriptions under the same Customer account by adding the <code>CUSTOMERID</code> (case sensitive) parameter to <strong>Buy links</strong>.</td></tr><tr><td><code>FirstName</code></td><td><strong>Required (string)</strong><br>Customer's first name. </td></tr><tr><td><code>LastName</code></td><td><strong>Required (string)</strong><br>Customer's last name.</td></tr><tr><td><code>Company</code></td><td><strong>Optional (string)</strong><br>Company name.</td></tr><tr><td><code>FiscalCode</code></td><td><p><strong>Optional (string)</strong><br>Can be null for end users. For companies, it needs to be the VAT ID, which 2Checkout validates.</p><p>2Checkout throws an error if the VAT ID is invalid/incorrect. When present, you also need to provide the company name.</p><p>Can be <strong>null</strong> for end users.</p></td></tr><tr><td><code>Address1</code></td><td><strong>Required (string)</strong><br>Customer's address.</td></tr><tr><td><code>Address2</code></td><td><strong>Optional (string)</strong><br>Customer's address.</td></tr><tr><td><code>City</code></td><td><strong>Required (string)</strong><br>Customer's city.</td></tr><tr><td><code>State</code></td><td><strong>Optional (string)</strong><br>Customer's state. For example, "Alabama", "Alaska", "Arizona".</td></tr><tr><td><code>Zip</code></td><td><strong>Required (string)</strong><br>Zip code.</td></tr><tr><td><code>CountryCode</code></td><td><strong>Required (string)</strong><br>Customer's country code (ISO 3166 two-letter code).</td></tr><tr><td><code>Phone</code></td><td><strong>Optional (string)</strong><br>Customer's phone number.</td></tr><tr><td><code>Fax</code></td><td><strong>Optional (string)</strong><br>Customer's fax number.</td></tr><tr><td><code>Email</code></td><td><strong>Required (string)</strong><br>Customer's email.</td></tr><tr><td><code>Enabled</code></td><td><p><strong>Optional (boolean)</strong></p><p><strong>True</strong> or <strong>false</strong>, depending on whether the customer account is active or inactive. An active customer account features at least one <strong>Active</strong> or <strong>Past due</strong> subscription. Possible customer statuses:</p><ul><li>Active - Customer account status is Active even if Trial and Cancelled/Expired subscriptions exist for the customer, along as there's at least one Active subscription. Customers with a single subscription featuring the Past due status (expired but in the grace period) are considered Active.</li><li>Inactive - All subscriptions associated to this Customer account are cancelled, expired or both.</li><li>Trial - Customer account status is Trial if all Active subscriptions for this customer are trials, regardless of any Cancelled/Expired subscriptions.</li></ul></td></tr><tr><td><code>Trial</code></td><td><strong>Optional (boolean)</strong><br><strong>True</strong> or <strong>false</strong>, depending on whether the customer account features only trials or also paid subscriptions.</td></tr><tr><td><code>Language</code></td><td><strong>Optional (string)</strong><br>ISO 639-1 two-letter code. Example: “en.”</td></tr><tr><td><code>Credit</code></td><td><strong>Optional (object)</strong><br>Contains information about the credit limit, remaining credit and credit currency.</td></tr><tr><td><code>Credit.Limit</code></td><td><strong>Float</strong><br>The limit must be 0 or a positive number.</td></tr><tr><td><code>Credit.Remaining</code></td><td><strong>Float</strong><br>The remaining must be a valid number.</td></tr><tr><td><code>Credit.Currency</code></td><td><strong>String</strong><br>Currency code must be one of the transactional currencies set on account.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.2checkout.com/soap-api-reference/soap-api-6.0/api-requests/customer.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.