Customers - Update

Update an existing customer.

Example request (cURL)

cURL
curl --request POST \
  --url https://sandbox.hyperswitch.io/v2/customers/{id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "email": "[email protected]",
  "name": "John Doe"
}
'

Example response (200)

{
  "id": "12345_cus_01926c58bc6e77c09e809964e72af8c8",
  "merchant_reference_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "created_at": "2023-01-18T11:04:09.922Z",
  "connector_customer_ids": {},
  "name": "Jon Test",
  "email": "[email protected]",
  "phone": "9123456789",
  "phone_country_code": "+65",
  "description": "First Customer",
  "default_billing_address": {
    "city": "New York",
    "country": "AF",
    "line1": "123, King Street",
    "line2": "Powelson Avenue",
    "line3": "Bridgewater",
    "zip": "08807",
    "state": "New York",
    "first_name": "John",
    "last_name": "Doe",
    "origin_zip": "08807"
  },
  "default_shipping_address": {
    "city": "New York",
    "country": "AF",
    "line1": "123, King Street",
    "line2": "Powelson Avenue",
    "line3": "Bridgewater",
    "zip": "08807",
    "state": "New York",
    "first_name": "John",
    "last_name": "Doe",
    "origin_zip": "08807"
  },
  "metadata": {},
  "default_payment_method_id": "12345_pm_01926c58bc6e77c09e809964e72af8c8",
  "tax_registration_id": "123456789"
}

HTTP

POST /v2/customers/{id}

Authorizations

api-key (header, required) — string

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Do not expose your api-key in client-side code or public repositories.

Path Parameters

  • id (string, required) The unique identifier for the Customer

Body (application/json)

  • name (string, required) The customer's name Maximum string length: 255 Example: "Jon Test"

  • email (string, required) The customer's email address Maximum string length: 255 Example: "[email protected]"

  • phone (string | null) The customer's phone number Maximum string length: 255 Example: "9123456789"

  • description (string | null) An arbitrary string that you can attach to a customer object. Maximum string length: 255 Example: "First Customer"

  • phone_country_code (string | null) The country code for the customer phone number Maximum string length: 255 Example: "+65"

  • default_billing_address (object) Address details (see below)

  • default_shipping_address (object) Address details (see below)

  • metadata (object) You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.

  • default_payment_method_id (string | null) The unique identifier of the payment method Example: "12345_pm_01926c58bc6e77c09e809964e72af8c8"

  • tax_registration_id (string | null) The customer's tax registration number. Maximum string length: 255 Example: "123456789"

default_billing_address / default_shipping_address attributes

The address object contains fields such as:

  • city

  • country

  • line1

  • line2

  • line3

  • zip

  • state

  • first_name

  • last_name

  • origin_zip

(These fields are shown in the example response above.)

Response (200 — application/json)

Customer was Updated. Response fields:

  • id (string, required) Unique identifier for the customer Required string length: 32 - 64 Example: "12345_cus_01926c58bc6e77c09e809964e72af8c8"

  • merchant_reference_id (string, required) The identifier for the customer object Required string length: 1 - 64 Example: "cus_y3oqhf46pyzuxjbcn2giaqnb44"

  • created_at (string, required) A timestamp (ISO 8601) when the customer was created Example: "2023-01-18T11:04:09.922Z"

  • connector_customer_ids (object) Connector specific customer reference ids

  • name (string | null) The customer's name Maximum string length: 255 Example: "Jon Test"

  • email (string | null) The customer's email address Maximum string length: 255 Example: "[email protected]"

  • phone (string | null) The customer's phone number Maximum string length: 255 Example: "9123456789"

  • phone_country_code (string | null) The country code for the customer phone number Maximum string length: 255 Example: "+65"

  • description (string | null) An arbitrary string that you can attach to a customer object. Maximum string length: 255 Example: "First Customer"

  • default_billing_address (object) Address details (see example)

  • default_shipping_address (object) Address details (see example)

  • metadata (object) You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.

  • default_payment_method_id (string | null) The identifier for the default payment method. Maximum string length: 64 Example: "12345_pm_01926c58bc6e77c09e809964e72af8c8"

  • tax_registration_id (string | null) The customer's tax registration number. Maximum string length: 255 Example: "123456789"

Was this page helpful? Yes / No

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v2/customers/customers--update.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v2/customers/customers--update

Related:

  • Customers - Retrieve: https://api-reference.hyperswitch.io/v2/customers/customers--retrieve

  • Customers - Delete: https://api-reference.hyperswitch.io/v2/customers/customers--delete

PreviousPayments - Session tokenNextConnector Account - Retrieve