Skip to main content
PATCH
/
v1
/
customers
/
{id}
Go (SDK)
package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Customers.Update(ctx, "<value>", components.CustomerUpdate{
        Email: polargo.Pointer("[email protected]"),
        Name: polargo.Pointer("John Doe"),
        BillingAddress: &components.AddressInput{
            Country: components.CountryAlpha2InputUs,
        },
        TaxID: []*components.CustomerUpdateTaxID{
            polargo.Pointer(components.CreateCustomerUpdateTaxIDStr(
                "911144442",
            )),
            polargo.Pointer(components.CreateCustomerUpdateTaxIDStr(
                "us_ein",
            )),
        },
        ExternalID: polargo.Pointer("usr_1337"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Customer != nil {
        // handle response
    }
}
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "external_id": "usr_1337",
  "email": "<string>",
  "email_verified": true,
  "name": "John Doe",
  "billing_address": {
    "country": "AD",
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "state": "<string>"
  },
  "tax_id": [
    "911144442",
    "us_ein"
  ],
  "organization_id": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "avatar_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid4>
required

The customer ID.

Body

application/json
​
metadata
Metadata · object

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.

​
email
string<email> | null

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

Example:

"[email protected]"

​
name
string | null

The name of the customer.

Maximum string length: 256
Example:

"John Doe"

​
billing_address
AddressInput · object
​
tax_id
any[] | null
Required array length: 2 elements
Example:
["911144442", "us_ein"]
​
external_id
string | null

The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.

Example:

"usr_1337"

Response

Customer updated.

A customer in an organization.

​
id
string<uuid4>
required

The ID of the customer.

​
created_at
string<date-time>
required

Creation timestamp of the object.

​
modified_at
string<date-time> | null
required

Last modification timestamp of the object.

​
metadata
Metadata · object
required
​
external_id
string | null
required

The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.

Example:

"usr_1337"

​
email
string
required

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

​
email_verified
boolean
required

Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.

​
name
string | null
required

The name of the customer.

Example:

"John Doe"

​
billing_address
Address · object
required
​
tax_id
any[] | null
required
Required array length: 2 elements
Example:
["911144442", "us_ein"]
​
organization_id
string<uuid4>
required

The ID of the organization owning the customer.

​
deleted_at
string<date-time> | null
required

Timestamp for when the customer was soft deleted.

​
avatar_url
string
required