Get Customer
Retrieve detailed information about a specific customer including their subscriptions, add-ons, and entitlements
curl --request GET \
--url https://api.useautumn.com/v1/customers/{customer_id} \
--header 'Authorization: Bearer <token>'{
"customer": {
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"fingerprint": "<string>",
"created_at": 123,
"env": "<string>",
"processor": {
"id": "<string>",
"type": "<string>"
}
},
"products": [
{
"id": "<string>",
"name": "<string>",
"group": "<string>",
"status": "active",
"created_at": 123,
"canceled_at": 123,
"processor": {
"type": "<string>",
"subscription_id": "<string>"
},
"prices": [
{
"amount": 123,
"interval": "month"
}
]
}
],
"add_ons": [
{
"id": "<string>",
"name": "<string>",
"group": "<string>",
"status": "active",
"created_at": 123,
"canceled_at": 123,
"processor": {
"type": "<string>",
"subscription_id": "<string>"
},
"prices": [
{
"amount": 123,
"interval": "month"
}
]
}
],
"entitlements": [
{
"feature_id": "<string>",
"interval": "<string>",
"balance": 123,
"total": 123,
"unlimited": true,
"used": 123
}
],
"invoices": [
{
"product_ids": [
"<string>"
],
"stripe_id": "<string>",
"status": "paid",
"total": 123,
"currency": "<string>",
"created_at": 123,
"hosted_invoice_url": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier for the customer
Response
Additional customer details
Unique identifier for the customer
Customer's username or display name
Customer's email address
Unique fingerprint for the customer
Timestamp of customer creation in milliseconds since epoch
Environment the customer belongs to
List of active products for the customer
Unique identifier for the product
Display name of the product
Product grouping category
Current status of the product subscription. We only return active products.
active Timestamp of product creation in milliseconds since epoch
Timestamp of cancellation, if applicable
List of active add-ons for the customer
Unique identifier for the product
Display name of the product
Product grouping category
Current status of the product subscription. We only return active products.
active Timestamp of product creation in milliseconds since epoch
Timestamp of cancellation, if applicable
List of active entitlements for the customer
Unique identifier for the feature
Time interval for the entitlement
Remaining balance of the entitlement
Total allocation of the entitlement
Whether the entitlement has unlimited usage
Amount of the entitlement that has been used
List of past invoices the customer has paid
List of product IDs included in this invoice
Stripe invoice ID
Payment status of the invoice
paid, unpaid, void Total amount of the invoice
Currency code for the invoice
Timestamp of invoice creation in milliseconds since epoch
URL to view the hosted invoice page
curl --request GET \
--url https://api.useautumn.com/v1/customers/{customer_id} \
--header 'Authorization: Bearer <token>'{
"customer": {
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"fingerprint": "<string>",
"created_at": 123,
"env": "<string>",
"processor": {
"id": "<string>",
"type": "<string>"
}
},
"products": [
{
"id": "<string>",
"name": "<string>",
"group": "<string>",
"status": "active",
"created_at": 123,
"canceled_at": 123,
"processor": {
"type": "<string>",
"subscription_id": "<string>"
},
"prices": [
{
"amount": 123,
"interval": "month"
}
]
}
],
"add_ons": [
{
"id": "<string>",
"name": "<string>",
"group": "<string>",
"status": "active",
"created_at": 123,
"canceled_at": 123,
"processor": {
"type": "<string>",
"subscription_id": "<string>"
},
"prices": [
{
"amount": 123,
"interval": "month"
}
]
}
],
"entitlements": [
{
"feature_id": "<string>",
"interval": "<string>",
"balance": 123,
"total": 123,
"unlimited": true,
"used": 123
}
],
"invoices": [
{
"product_ids": [
"<string>"
],
"stripe_id": "<string>",
"status": "paid",
"total": 123,
"currency": "<string>",
"created_at": 123,
"hosted_invoice_url": "<string>"
}
]
}