Sign in

v20

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-214885191.3 KB
Customers

Update a customer

Updates an existing customer identified by reference. Use this to backfill or change fields such as externalRef, name, or email. Only the fields supplied in the body are modified.

patch/v1/sdk/customers/{reference}

Path parameters

referencestring required
Example:cus_3c4d5e6f7g8h

Customer reference identifier

Request body

descriptionstring
emailstring email
externalRefstring
{"stackTrail":"components:schemas:UpdateCustomerRequest:properties:metadata","oasType":"schema","type":"unknown"}
namestring

Response

Customer updated successfully

emailstring required

Customer email address

externalRefstring

External reference ID from your auth system (if set during creation or update)

namestring required

Customer full name

referencestring required

Customer reference identifier

Example response

{
  "email": "customer@example.com",
  "externalRef": "auth_user_12345",
  "name": "John Doe",
  "purchases": [
    {
      "amount": 9900,
      "cancellationReason": "Customer request",
      "cancelledAt": "2025-10-28T10:00:00Z",
      "currency": "GBP",
      "endDate": "2025-11-27T10:00:00Z",
      "exchangeRate": 1.32,
      "originalAmount": 7500,
      "planRef": "pln_abc123",
      "productName": "API Gateway Manager",
      "productRef": "prd_abc123",
      "reference": "pur_1A2B3C4D",
      "startDate": "2025-10-27T10:00:00Z",
      "status": "active"
    }
  ],
  "reference": "cus_3c4d5e6f7g8h"
}