> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# appmixer.stripe.core.RetrieveCustomer

- Component: `appmixer.stripe.core.RetrieveCustomer`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.stripe 3.1.0](https://connectors.appmixer.com/connector/appmixer.stripe/3.1.0.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.stripe/3.1.0/component/appmixer.stripe.core.RetrieveCustomer>

Retrieves the details of an existing customer by their ID.

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Customer Id (`customerId`) | text | The identifier of the Customer to retrieve. |

## Output ports

### Port `out`

| Field | Type | Description |
| --- | --- | --- |
| Id (`id`) | string | - |
| Object (`object`) | string | - |
| Address (`address`) | object | - |
| Balance (`balance`) | number | - |
| Created (`created`) | number | - |
| Currency (`currency`) | string | - |
| Default Source (`default_source`) | string | - |
| Delinquent (`delinquent`) | boolean | - |
| Description (`description`) | string | - |
| Email (`email`) | string | - |
| Invoice Prefix (`invoice_prefix`) | string | - |
| Invoice Settings (`invoice_settings`) | object | - |
| Livemode (`livemode`) | boolean | - |
| Metadata (`metadata`) | object | - |
| Name (`name`) | string | - |
| Next Invoice Sequence (`next_invoice_sequence`) | number | - |
| Phone (`phone`) | string | - |
| Shipping (`shipping`) | object | - |
| Tax Exempt (`tax_exempt`) | string | - |
| Test Clock (`test_clock`) | string | - |

## Full metadata (component.json)

```json
{
  "name": "appmixer.stripe.core.RetrieveCustomer",
  "author": "Appmixer <info@appmixer.com>",
  "description": "Retrieves the details of an existing customer by their ID.",
  "version": "1.0.0",
  "private": false,
  "auth": {
    "service": "appmixer:stripe"
  },
  "quota": {
    "manager": "appmixer:stripe",
    "resources": "requests"
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "customerId": {
            "type": "string"
          }
        },
        "required": [
          "customerId"
        ]
      },
      "inspector": {
        "inputs": {
          "customerId": {
            "type": "text",
            "tooltip": "The identifier of the Customer to retrieve.",
            "label": "Customer Id",
            "index": 0
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "options": [
        {
          "label": "Id",
          "value": "id",
          "schema": {
            "type": "string",
            "example": "cus_ABC123DEF456"
          }
        },
        {
          "label": "Object",
          "value": "object",
          "schema": {
            "type": "string",
            "example": "customer"
          }
        },
        {
          "label": "Address",
          "value": "address",
          "schema": {
            "type": "object",
            "properties": {
              "city": {
                "type": "string",
                "title": "City"
              },
              "country": {
                "type": "string",
                "title": "Country"
              },
              "line1": {
                "type": "string",
                "title": "Line1"
              },
              "line2": {
                "type": "string",
                "title": "Line2"
              },
              "postal_code": {
                "type": "string",
                "title": "PostalCode"
              },
              "state": {
                "type": "string",
                "title": "State"
              }
            },
            "example": {
              "city": "New York",
              "country": "US",
              "line1": "350 Fifth Avenue",
              "line2": "Floor 21",
              "postal_code": "10118",
              "state": "NY"
            }
          }
        },
        {
          "label": "Balance",
          "value": "balance",
          "schema": {
            "type": "number",
            "example": -5000
          }
        },
        {
          "label": "Created",
          "value": "created",
          "schema": {
            "type": "number",
            "example": 1735689600
          }
        },
        {
          "label": "Currency",
          "value": "currency",
          "schema": {
            "type": "string",
            "example": "usd"
          }
        },
        {
          "label": "Default Source",
          "value": "default_source",
          "schema": {
            "type": "string",
            "example": "card_ABC123"
          }
        },
        {
          "label": "Delinquent",
          "value": "delinquent",
          "schema": {
            "type": "boolean",
            "example": false
          }
        },
        {
          "label": "Description",
          "value": "description",
          "schema": {
            "type": "string",
            "example": "Enterprise account"
          }
        },
        {
          "label": "Email",
          "value": "email",
          "schema": {
            "type": "string",
            "example": "billing@acme.com"
          }
        },
        {
          "label": "Invoice Prefix",
          "value": "invoice_prefix",
          "schema": {
            "type": "string",
            "example": "ACME"
          }
        },
        {
          "label": "Invoice Settings",
          "value": "invoice_settings",
          "schema": {
            "type": "object",
            "properties": {
              "custom_fields": {
                "type": "string",
                "title": "Invoice Settings.Custom Fields"
              },
              "default_payment_method": {
                "type": "string",
                "title": "Invoice Settings.Default Payment Method"
              },
              "footer": {
                "type": "string",
                "title": "Invoice Settings.Footer"
              },
              "rendering_options": {
                "type": "string",
                "title": "Invoice Settings.Rendering Options"
              }
            },
            "example": {
              "custom_fields": null,
              "default_payment_method": "pm_1MvoiELkdIwHu7ix",
              "footer": "Thank you for your business.",
              "rendering_options": null
            }
          }
        },
        {
          "label": "Livemode",
          "value": "livemode",
          "schema": {
            "type": "boolean",
            "example": false
          }
        },
        {
          "label": "Metadata",
          "value": "metadata",
          "schema": {
            "type": "object",
            "properties": {},
            "example": {
              "order_id": "6735"
            }
          }
        },
        {
          "label": "Name",
          "value": "name",
          "schema": {
            "type": "string",
            "example": "Acme Corporation"
          }
        },
        {
          "label": "Next Invoice Sequence",
          "value": "next_invoice_sequence",
          "schema": {
            "type": "number",
            "example": 4
          }
        },
        {
          "label": "Phone",
          "value": "phone",
          "schema": {
            "type": "string",
            "example": "+1987654321"
          }
        },
        {
          "label": "Shipping",
          "value": "shipping",
          "schema": {
            "type": "object",
            "properties": {
              "address": {
                "type": "object",
                "title": "Shipping Address",
                "properties": {
                  "city": {
                    "type": "string",
                    "title": "City"
                  },
                  "country": {
                    "type": "string",
                    "title": "Country"
                  },
                  "line1": {
                    "type": "string",
                    "title": "Line1"
                  },
                  "line2": {
                    "type": "string",
                    "title": "Line2"
                  },
                  "postal_code": {
                    "type": "string",
                    "title": "PostalCode"
                  },
                  "state": {
                    "type": "string",
                    "title": "State"
                  }
                }
              },
              "name": {
                "type": "string",
                "title": "Customer Name"
              },
              "phone": {
                "type": "string",
                "title": "Customer Phone"
              }
            },
            "example": {
              "address": {
                "city": "New York",
                "country": "US",
                "line1": "350 Fifth Avenue",
                "line2": "Floor 21",
                "postal_code": "10118",
                "state": "NY"
              },
              "name": "Acme Corporation",
              "phone": "+12125550199"
            }
          }
        },
        {
          "label": "Tax Exempt",
          "value": "tax_exempt",
          "schema": {
            "type": "string",
            "example": "none"
          }
        },
        {
          "label": "Test Clock",
          "value": "test_clock",
          "schema": {
            "type": "string",
            "example": null
          }
        }
      ]
    }
  ],
  "icon": "(data URI omitted)"
}
```
