Update a customer - Documentation

PATCH

customers

{id}

Update a customer

curl --request PATCH \
  --url https://sandbox-api.paynext.com/customers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "city": "San Francisco",
    "line1": "123 Market Street",
    "line2": "Suite 400",
    "postal_code": "94105",
    "state": "CA"
  },
  "email": "jane.doe@example.com",
  "full_name": "Jane Doe",
  "metadata": {
    "key": "value"
  },
  "phone": "+1234567890"
}
'

{
  "address": {
    "city": "San Francisco",
    "line1": "123 Market Street",
    "line2": "Suite 400",
    "postal_code": "94105",
    "state": "CA"
  },
  "created_at": "2025-05-28T14:00:00Z",
  "email": "alice.johnson@example.com",
  "external_id": "ext_001",
  "full_name": "Alice Johnson",
  "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
  "metadata": {
    "key": "value"
  },
  "payment_methods": [
    {
      "details": {
        "bin": "411111",
        "bin_data": {
          "currency_code": "<string>",
          "description": "Chase Sapphire Preferred",
          "issuer": "Chase Bank"
        },
        "exp_month": 12,
        "exp_year": 2028,
        "is_network_tokenized": true,
        "last4": "1111",
        "number": "4111111111111111"
      },
      "billing_address": {
        "city": "San Francisco",
        "line1": "123 Market Street",
        "line2": "Suite 400",
        "postal_code": "94105",
        "state": "CA"
      }
    }
  ],
  "phone": "+1-555-123-4567",
  "subscriptions": [
    {
      "created_at": "2025-05-26T10:00:00Z",
      "current_period_end": "<string>",
      "current_period_start": "<string>",
      "id": "sub_123e4567-e89b-12d3-a456-426614174000",
      "metadata": {
        "key": "value"
      },
      "next_billing_date": "2025-06-26T12:00:00Z",
      "past_due": {
        "attempt_count": 2,
        "max_attempts_count": 7
      },
      "plan": {
        "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "interval": "days",
        "interval_count": 1,
        "name": "Pro Plan",
        "price": {
          "amount": 1999,
          "currency": "AED"
        },
        "tax": {
          "collect_tax": "<unknown>"
        },
        "trial_interval": "days",
        "trial_interval_count": 14,
        "trial_price": {
          "amount": 1999,
          "currency": "AED"
        },
        "type": "recurring"
      },
      "updated_at": "2025-05-27T10:00:00Z"
    }
  ],
  "updated_at": "2025-05-28T14:05:00Z"
}

Authorizations

Authorization

string

header

required

Authentication header of the form api key, where api key is your organization api key.

Headers

X-API-Version

enum<string>

Specifies the version of the API to use

Available options:

1.0.0

Path Parameters

string

required

The ID of the customer to update

Body

application/json

Update customer data

address

object

Billing address of the customer

Show child attributes

string

Email address of the customer

Example:

"jane.doe@example.com"

full_name

string

Full name of the customer

Example:

"Jane Doe"

metadata

object

Custom metadata associated with the customer. A dictionary of key-value pairs that is deep-merged into any existing metadata.

Show child attributes

Example:

{ "key": "value" }

phone

string

Phone number of the customer in E.164 format

Example:

"+1234567890"

Response

address

object

Address associated with customer

Show child attributes

created_at

string

The date and time the customer was created in UTC format

Example:

"2025-05-28T14:00:00Z"

string

Email of the customer

Example:

"alice.johnson@example.com"

external_id

string

External ID of the customer

Example:

"ext_001"

full_name

string

Full name of the customer

Example:

"Alice Johnson"

string

Unique identifier

Example:

"cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f"

metadata

object

Additional metadata as a JSON object

Show child attributes

Example:

{ "key": "value" }

payment_methods

Show child attributes

phone

string

Customer's phone number

Example:

"+1-555-123-4567"

subscriptions

object[]

Show child attributes

updated_at

string

The date and time the customer was last updated in UTC format

Example:

"2025-05-28T14:05:00Z"

Find paymentsFind payments

⌘I

Update a customer

curl --request PATCH \
  --url https://sandbox-api.paynext.com/customers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "city": "San Francisco",
    "line1": "123 Market Street",
    "line2": "Suite 400",
    "postal_code": "94105",
    "state": "CA"
  },
  "email": "jane.doe@example.com",
  "full_name": "Jane Doe",
  "metadata": {
    "key": "value"
  },
  "phone": "+1234567890"
}
'

{
  "address": {
    "city": "San Francisco",
    "line1": "123 Market Street",
    "line2": "Suite 400",
    "postal_code": "94105",
    "state": "CA"
  },
  "created_at": "2025-05-28T14:00:00Z",
  "email": "alice.johnson@example.com",
  "external_id": "ext_001",
  "full_name": "Alice Johnson",
  "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
  "metadata": {
    "key": "value"
  },
  "payment_methods": [
    {
      "details": {
        "bin": "411111",
        "bin_data": {
          "currency_code": "<string>",
          "description": "Chase Sapphire Preferred",
          "issuer": "Chase Bank"
        },
        "exp_month": 12,
        "exp_year": 2028,
        "is_network_tokenized": true,
        "last4": "1111",
        "number": "4111111111111111"
      },
      "billing_address": {
        "city": "San Francisco",
        "line1": "123 Market Street",
        "line2": "Suite 400",
        "postal_code": "94105",
        "state": "CA"
      }
    }
  ],
  "phone": "+1-555-123-4567",
  "subscriptions": [
    {
      "created_at": "2025-05-26T10:00:00Z",
      "current_period_end": "<string>",
      "current_period_start": "<string>",
      "id": "sub_123e4567-e89b-12d3-a456-426614174000",
      "metadata": {
        "key": "value"
      },
      "next_billing_date": "2025-06-26T12:00:00Z",
      "past_due": {
        "attempt_count": 2,
        "max_attempts_count": 7
      },
      "plan": {
        "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "interval": "days",
        "interval_count": 1,
        "name": "Pro Plan",
        "price": {
          "amount": 1999,
          "currency": "AED"
        },
        "tax": {
          "collect_tax": "<unknown>"
        },
        "trial_interval": "days",
        "trial_interval_count": 14,
        "trial_price": {
          "amount": 1999,
          "currency": "AED"
        },
        "type": "recurring"
      },
      "updated_at": "2025-05-27T10:00:00Z"
    }
  ],
  "updated_at": "2025-05-28T14:05:00Z"
}