• Pricing
  • Blog
Log inBook a demo
Batch create customers POSTGrant customer credit POSTCreate customer POSTGet customer GETList customer credits GETList customers GETRevoke remaining customer credit POSTUpdate customer PATCH
System status
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

Update customer

Update a customer's name, external ID, or metadata.

PATCH
/customers/{id}

Update a customer's name, external ID, or metadata.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

id*string

Header Parameters

Idempotency-Key?string

Unique key used to safely retry this write for 24 hours without applying it twice.

Length1 <= length <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/customers/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "externalId": "string",  "fullName": "string",  "email": "string",  "taxDocument": "string",  "documentType": "string",  "timezone": "string",  "metadata": {    "property1": null,    "property2": null  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "object": "customer",  "livemode": true}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

Revoke remaining customer credit POST

Revoke the unallocated remainder of a customer credit grant. Applied invoice history is unchanged.

Create feature POST

Create a new feature. Code must be lowercase alphanumeric with underscores.

email?string
Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
fullName?string
Lengthlength <= 200
taxDocument?string
Lengthlength <= 50
externalId?string
Lengthlength <= 200
timezone?Timezone
Default"UTC"

Value in

  • "UTC"
  • "America/New_York"
  • "America/Chicago"
  • "America/Denver"
  • "America/Los_Angeles"
  • "America/Sao_Paulo"
  • "America/Mexico_City"
  • "America/Buenos_Aires"
  • "America/Santiago"
  • "America/Bogota"
  • "America/Lima"
  • "America/Asuncion"
  • "Europe/London"
  • "Europe/Paris"
  • "Europe/Berlin"
  • "Europe/Madrid"
  • "Asia/Tokyo"
  • "Asia/Shanghai"
  • "Asia/Singapore"
  • "Asia/Dubai"
  • "Australia/Sydney"
metadata?
address?