Skip to main content
GET
/
v1
/
customers
/
{id}
curl -X GET https://api.flexprice.io/v1/customers/cust_abc123xyz789 \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "id": "cust_abc123xyz789",
  "external_id": "user_12345",
  "name": "Acme Corporation",
  "email": "billing@acme.com",
  "address_line1": "123 Main Street",
  "address_line2": "",
  "address_city": "San Francisco",
  "address_state": "CA",
  "address_postal_code": "94105",
  "address_country": "US",
  "parent_customer_id": null,
  "metadata": {
    "plan_tier": "enterprise",
    "account_manager": "jane_doe"
  },
  "environment_id": "env_prod_001",
  "tenant_id": "tenant_001",
  "status": "published",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "created_by": "user_admin",
  "updated_by": "user_admin"
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/flexprice/flexprice/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint when you need to load a single customer (e.g., for a billing portal or to attach a subscription).

​
Path Parameters

​
id
string
required
The unique FlexPrice customer ID (e.g., cust_abc123xyz789).

​
Query Parameters

​
expand
string
Expand related resources in the response (e.g., parent_customer to include parent customer details).

​
Response

​
id
string
The unique FlexPrice customer ID.
​
external_id
string
The external identifier from your system.
​
name
string
The customer’s name or company name.
​
email
string
The customer’s email address.
​
address_line1
string
Primary address line.
​
address_line2
string
Secondary address line.
​
address_city
string
City name.
​
address_state
string
State or region name.
​
address_postal_code
string
Postal code.
​
address_country
string
Two-letter ISO 3166-1 alpha-2 country code.
​
parent_customer_id
string
The parent customer ID if this is a child customer.
​
metadata
object
Custom metadata key-value pairs.
​
environment_id
string
The environment ID this customer belongs to.
​
tenant_id
string
The tenant ID this customer belongs to.
​
status
string
The status of the customer (e.g., published, draft, archived).
​
created_at
string
ISO 8601 timestamp of when the customer was created.
​
updated_at
string
ISO 8601 timestamp of when the customer was last updated.
​
created_by
string
The ID of the user who created the customer.
​
updated_by
string
The ID of the user who last updated the customer.
​
parent_customer
object
The parent customer object if expand=parent_customer is specified and a parent exists.
curl -X GET https://api.flexprice.io/v1/customers/cust_abc123xyz789 \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "id": "cust_abc123xyz789",
  "external_id": "user_12345",
  "name": "Acme Corporation",
  "email": "billing@acme.com",
  "address_line1": "123 Main Street",
  "address_line2": "",
  "address_city": "San Francisco",
  "address_state": "CA",
  "address_postal_code": "94105",
  "address_country": "US",
  "parent_customer_id": null,
  "metadata": {
    "plan_tier": "enterprise",
    "account_manager": "jane_doe"
  },
  "environment_id": "env_prod_001",
  "tenant_id": "tenant_001",
  "status": "published",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "created_by": "user_admin",
  "updated_by": "user_admin"
}
If you need to retrieve a customer by external ID instead of the FlexPrice ID, use the Get Customer by External ID endpoint.