POpolar
customers
public

Update Customer by External ID

Changed on

Update a customer by external ID.

Scopes: customers:write

patch/v1/customers/external/{external_id}

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/customers/external/{external_id}
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: customers:write)
    • or HTTP bearer
    • or HTTP bearer

Path parameters

external_idstring required

The customer external ID.

Request body

metadataobject

Key-value object allowing you to store additional information.

The key must be a string with a maximum length of 40 characters. The value must be either:

  • A string with a maximum length of 500 characters
  • An integer
  • A floating-point number
  • A boolean

You can store up to 50 key-value pairs.

emailstring email nullable

The email address of the customer. This must be unique within the organization.

namestring nullable

The name of the customer.

tax_idstring nullable
localestring nullable

Locale of the customer, given as an IETF BCP 47 language tag, e.g. en, en-US or en-GB-oxendict. If null or unsupported, the locale will default to en.

Example request

{
  "email": "customer@example.com",
  "name": "John Doe",
  "billing_address": {
    "country": "US"
  },
  "locale": "en"
}

Response

Customer updated.

Customer required(unresolved $ref)

Changes

  • f9688fd328d6Revision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status