API ReferenceUsers

Update a customer

Update customer profile and budget settings. Customers are created automatically from usage; use this endpoint to configure budgets or update profile fields after creation.

Path parameters

customer_identifierstringRequired
Your unique identifier for this customer.

Headers

AuthorizationstringRequired

Bearer token. Use Bearer YOUR_API_KEY.

Query parameters

environmentenumOptional
Optional environment filter. If omitted, the backend uses the environment implied by your auth context when applicable.
Allowed values:

Request

This endpoint expects an object.
emailstring or nullOptional
Customer email address.
namestring or nullOptional
Customer display name.
metadataobjectOptional

Custom key-value metadata.

period_budgetdouble or nullOptional
Spending budget per period in USD.
budget_durationenumOptional
Budget renewal period.
Allowed values:
total_budgetdouble or nullOptional
Total lifetime spending budget in USD.
period_startdatetimeOptional
Optional custom budget period start.
period_enddatetime or nullOptional
Optional custom budget period end.
markup_percentagedoubleOptional
Markup percentage applied to usage reports for this customer.

Response

Updated customer details.
idstring
Customer identifier used by the detail serializer.
namestring or null
Customer display name.
emailstring or null
Customer email address.
customer_identifierstring
Your unique identifier for the customer.
environmentenum
Customer environment.
Allowed values:
total_budgetdouble or null
Lifetime spending budget in USD.
period_budgetdouble or null
Current period budget in USD.
organization_namestring or null
Owning organization name.
total_period_usagedouble
Usage in the current budget period in USD.
period_startdatetime
Start of the current budget period.
period_enddatetime or null
End of the current budget period.
budget_durationenum
Budget renewal period.
Allowed values:
updated_atdatetime
Last update timestamp.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error