PATCH
/
v1
/
customers
/
external
/
{external_id}
PHP (SDK)
declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$customerUpdateExternalID = new Components\CustomerUpdateExternalID(
    email: 'customer@example.com',
    name: 'John Doe',
    billingAddress: null,
    taxId: [
        '911144442',
        'us_ein',
    ],
);

$response = $sdk->customers->updateExternal(
    externalId: '<id>',
    customerUpdateExternalID: $customerUpdateExternalID

);

if ($response->customer !== null) {
    // handle response
}
{
  "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "external_id": "usr_1337",
  "email": "customer@example.com",
  "email_verified": true,
  "name": "John Doe",
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "US"
  },
  "tax_id": [
    "911144442",
    "us_ein"
  ],
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "deleted_at": "2023-11-07T05:31:56Z",
  "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"
}

Authorizations

Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

external_id
string
required

The customer external ID.

Body

application/json

Response

200
application/json

Customer updated.

A customer in an organization.