Patch customer

Patch customer

curl --request PATCH \
  --url https://api.example.com/api/v1/customers/{id_or_alias} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias": "<string>",
  "billing_address": {
    "city": "<string>",
    "country": "US",
    "line1": "<string>",
    "line2": "<string>",
    "state": "<string>",
    "zip_code": "<string>"
  },
  "billing_email": "<string>",
  "currency": "EUR",
  "custom_properties": "<unknown>",
  "custom_taxes": [
    {
      "name": "<string>",
      "rate": "<string>",
      "tax_code": "<string>"
    }
  ],
  "invoicing_emails": [
    "<string>"
  ],
  "invoicing_entity_id": "ive_7n42DGM5Tflk9n8mt7Fhc7",
  "is_tax_exempt": true,
  "name": "<string>",
  "phone": "<string>",
  "shipping_address": {
    "same_as_billing": true,
    "address": {
      "city": "<string>",
      "country": "US",
      "line1": "<string>",
      "line2": "<string>",
      "state": "<string>",
      "zip_code": "<string>"
    }
  },
  "vat_number": "<string>"
}
'

import requests

url = "https://api.example.com/api/v1/customers/{id_or_alias}"

payload = {
    "alias": "<string>",
    "billing_address": {
        "city": "<string>",
        "country": "US",
        "line1": "<string>",
        "line2": "<string>",
        "state": "<string>",
        "zip_code": "<string>"
    },
    "billing_email": "<string>",
    "currency": "EUR",
    "custom_properties": "<unknown>",
    "custom_taxes": [
        {
            "name": "<string>",
            "rate": "<string>",
            "tax_code": "<string>"
        }
    ],
    "invoicing_emails": ["<string>"],
    "invoicing_entity_id": "ive_7n42DGM5Tflk9n8mt7Fhc7",
    "is_tax_exempt": True,
    "name": "<string>",
    "phone": "<string>",
    "shipping_address": {
        "same_as_billing": True,
        "address": {
            "city": "<string>",
            "country": "US",
            "line1": "<string>",
            "line2": "<string>",
            "state": "<string>",
            "zip_code": "<string>"
        }
    },
    "vat_number": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    alias: '<string>',
    billing_address: {
      city: '<string>',
      country: 'US',
      line1: '<string>',
      line2: '<string>',
      state: '<string>',
      zip_code: '<string>'
    },
    billing_email: '<string>',
    currency: 'EUR',
    custom_properties: '<unknown>',
    custom_taxes: [{name: '<string>', rate: '<string>', tax_code: '<string>'}],
    invoicing_emails: ['<string>'],
    invoicing_entity_id: 'ive_7n42DGM5Tflk9n8mt7Fhc7',
    is_tax_exempt: true,
    name: '<string>',
    phone: '<string>',
    shipping_address: {
      same_as_billing: true,
      address: {
        city: '<string>',
        country: 'US',
        line1: '<string>',
        line2: '<string>',
        state: '<string>',
        zip_code: '<string>'
      }
    },
    vat_number: '<string>'
  })
};

fetch('https://api.example.com/api/v1/customers/{id_or_alias}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/customers/{id_or_alias}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'alias' => '<string>',
    'billing_address' => [
        'city' => '<string>',
        'country' => 'US',
        'line1' => '<string>',
        'line2' => '<string>',
        'state' => '<string>',
        'zip_code' => '<string>'
    ],
    'billing_email' => '<string>',
    'currency' => 'EUR',
    'custom_properties' => '<unknown>',
    'custom_taxes' => [
        [
                'name' => '<string>',
                'rate' => '<string>',
                'tax_code' => '<string>'
        ]
    ],
    'invoicing_emails' => [
        '<string>'
    ],
    'invoicing_entity_id' => 'ive_7n42DGM5Tflk9n8mt7Fhc7',
    'is_tax_exempt' => true,
    'name' => '<string>',
    'phone' => '<string>',
    'shipping_address' => [
        'same_as_billing' => true,
        'address' => [
                'city' => '<string>',
                'country' => 'US',
                'line1' => '<string>',
                'line2' => '<string>',
                'state' => '<string>',
                'zip_code' => '<string>'
        ]
    ],
    'vat_number' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/customers/{id_or_alias}"

	payload := strings.NewReader("{\n  \"alias\": \"<string>\",\n  \"billing_address\": {\n    \"city\": \"<string>\",\n    \"country\": \"US\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip_code\": \"<string>\"\n  },\n  \"billing_email\": \"<string>\",\n  \"currency\": \"EUR\",\n  \"custom_properties\": \"<unknown>\",\n  \"custom_taxes\": [\n    {\n      \"name\": \"<string>\",\n      \"rate\": \"<string>\",\n      \"tax_code\": \"<string>\"\n    }\n  ],\n  \"invoicing_emails\": [\n    \"<string>\"\n  ],\n  \"invoicing_entity_id\": \"ive_7n42DGM5Tflk9n8mt7Fhc7\",\n  \"is_tax_exempt\": true,\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"shipping_address\": {\n    \"same_as_billing\": true,\n    \"address\": {\n      \"city\": \"<string>\",\n      \"country\": \"US\",\n      \"line1\": \"<string>\",\n      \"line2\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\"\n    }\n  },\n  \"vat_number\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v1/customers/{id_or_alias}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"alias\": \"<string>\",\n  \"billing_address\": {\n    \"city\": \"<string>\",\n    \"country\": \"US\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip_code\": \"<string>\"\n  },\n  \"billing_email\": \"<string>\",\n  \"currency\": \"EUR\",\n  \"custom_properties\": \"<unknown>\",\n  \"custom_taxes\": [\n    {\n      \"name\": \"<string>\",\n      \"rate\": \"<string>\",\n      \"tax_code\": \"<string>\"\n    }\n  ],\n  \"invoicing_emails\": [\n    \"<string>\"\n  ],\n  \"invoicing_entity_id\": \"ive_7n42DGM5Tflk9n8mt7Fhc7\",\n  \"is_tax_exempt\": true,\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"shipping_address\": {\n    \"same_as_billing\": true,\n    \"address\": {\n      \"city\": \"<string>\",\n      \"country\": \"US\",\n      \"line1\": \"<string>\",\n      \"line2\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\"\n    }\n  },\n  \"vat_number\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/customers/{id_or_alias}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"alias\": \"<string>\",\n  \"billing_address\": {\n    \"city\": \"<string>\",\n    \"country\": \"US\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip_code\": \"<string>\"\n  },\n  \"billing_email\": \"<string>\",\n  \"currency\": \"EUR\",\n  \"custom_properties\": \"<unknown>\",\n  \"custom_taxes\": [\n    {\n      \"name\": \"<string>\",\n      \"rate\": \"<string>\",\n      \"tax_code\": \"<string>\"\n    }\n  ],\n  \"invoicing_emails\": [\n    \"<string>\"\n  ],\n  \"invoicing_entity_id\": \"ive_7n42DGM5Tflk9n8mt7Fhc7\",\n  \"is_tax_exempt\": true,\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"shipping_address\": {\n    \"same_as_billing\": true,\n    \"address\": {\n      \"city\": \"<string>\",\n      \"country\": \"US\",\n      \"line1\": \"<string>\",\n      \"line2\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\"\n    }\n  },\n  \"vat_number\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "custom_properties": "<unknown>",
  "custom_taxes": [
    {
      "name": "<string>",
      "rate": "<string>",
      "tax_code": "<string>"
    }
  ],
  "id": "<string>",
  "invoicing_emails": [
    "<string>"
  ],
  "invoicing_entity_id": "<string>",
  "name": "<string>",
  "alias": "<string>",
  "billing_address": {
    "city": "<string>",
    "country": "US",
    "line1": "<string>",
    "line2": "<string>",
    "state": "<string>",
    "zip_code": "<string>"
  },
  "billing_email": "<string>",
  "connected_account_id": "<string>",
  "phone": "<string>",
  "shipping_address": {
    "same_as_billing": true,
    "address": {
      "city": "<string>",
      "country": "US",
      "line1": "<string>",
      "line2": "<string>",
      "state": "<string>",
      "zip_code": "<string>"
    }
  },
  "vat_number": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

PATCH

api

customers

{id_or_alias}

Patch customer

curl --request PATCH \
  --url https://api.example.com/api/v1/customers/{id_or_alias} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias": "<string>",
  "billing_address": {
    "city": "<string>",
    "country": "US",
    "line1": "<string>",
    "line2": "<string>",
    "state": "<string>",
    "zip_code": "<string>"
  },
  "billing_email": "<string>",
  "currency": "EUR",
  "custom_properties": "<unknown>",
  "custom_taxes": [
    {
      "name": "<string>",
      "rate": "<string>",
      "tax_code": "<string>"
    }
  ],
  "invoicing_emails": [
    "<string>"
  ],
  "invoicing_entity_id": "ive_7n42DGM5Tflk9n8mt7Fhc7",
  "is_tax_exempt": true,
  "name": "<string>",
  "phone": "<string>",
  "shipping_address": {
    "same_as_billing": true,
    "address": {
      "city": "<string>",
      "country": "US",
      "line1": "<string>",
      "line2": "<string>",
      "state": "<string>",
      "zip_code": "<string>"
    }
  },
  "vat_number": "<string>"
}
'

import requests

url = "https://api.example.com/api/v1/customers/{id_or_alias}"

payload = {
    "alias": "<string>",
    "billing_address": {
        "city": "<string>",
        "country": "US",
        "line1": "<string>",
        "line2": "<string>",
        "state": "<string>",
        "zip_code": "<string>"
    },
    "billing_email": "<string>",
    "currency": "EUR",
    "custom_properties": "<unknown>",
    "custom_taxes": [
        {
            "name": "<string>",
            "rate": "<string>",
            "tax_code": "<string>"
        }
    ],
    "invoicing_emails": ["<string>"],
    "invoicing_entity_id": "ive_7n42DGM5Tflk9n8mt7Fhc7",
    "is_tax_exempt": True,
    "name": "<string>",
    "phone": "<string>",
    "shipping_address": {
        "same_as_billing": True,
        "address": {
            "city": "<string>",
            "country": "US",
            "line1": "<string>",
            "line2": "<string>",
            "state": "<string>",
            "zip_code": "<string>"
        }
    },
    "vat_number": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    alias: '<string>',
    billing_address: {
      city: '<string>',
      country: 'US',
      line1: '<string>',
      line2: '<string>',
      state: '<string>',
      zip_code: '<string>'
    },
    billing_email: '<string>',
    currency: 'EUR',
    custom_properties: '<unknown>',
    custom_taxes: [{name: '<string>', rate: '<string>', tax_code: '<string>'}],
    invoicing_emails: ['<string>'],
    invoicing_entity_id: 'ive_7n42DGM5Tflk9n8mt7Fhc7',
    is_tax_exempt: true,
    name: '<string>',
    phone: '<string>',
    shipping_address: {
      same_as_billing: true,
      address: {
        city: '<string>',
        country: 'US',
        line1: '<string>',
        line2: '<string>',
        state: '<string>',
        zip_code: '<string>'
      }
    },
    vat_number: '<string>'
  })
};

fetch('https://api.example.com/api/v1/customers/{id_or_alias}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/customers/{id_or_alias}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'alias' => '<string>',
    'billing_address' => [
        'city' => '<string>',
        'country' => 'US',
        'line1' => '<string>',
        'line2' => '<string>',
        'state' => '<string>',
        'zip_code' => '<string>'
    ],
    'billing_email' => '<string>',
    'currency' => 'EUR',
    'custom_properties' => '<unknown>',
    'custom_taxes' => [
        [
                'name' => '<string>',
                'rate' => '<string>',
                'tax_code' => '<string>'
        ]
    ],
    'invoicing_emails' => [
        '<string>'
    ],
    'invoicing_entity_id' => 'ive_7n42DGM5Tflk9n8mt7Fhc7',
    'is_tax_exempt' => true,
    'name' => '<string>',
    'phone' => '<string>',
    'shipping_address' => [
        'same_as_billing' => true,
        'address' => [
                'city' => '<string>',
                'country' => 'US',
                'line1' => '<string>',
                'line2' => '<string>',
                'state' => '<string>',
                'zip_code' => '<string>'
        ]
    ],
    'vat_number' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/customers/{id_or_alias}"

	payload := strings.NewReader("{\n  \"alias\": \"<string>\",\n  \"billing_address\": {\n    \"city\": \"<string>\",\n    \"country\": \"US\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip_code\": \"<string>\"\n  },\n  \"billing_email\": \"<string>\",\n  \"currency\": \"EUR\",\n  \"custom_properties\": \"<unknown>\",\n  \"custom_taxes\": [\n    {\n      \"name\": \"<string>\",\n      \"rate\": \"<string>\",\n      \"tax_code\": \"<string>\"\n    }\n  ],\n  \"invoicing_emails\": [\n    \"<string>\"\n  ],\n  \"invoicing_entity_id\": \"ive_7n42DGM5Tflk9n8mt7Fhc7\",\n  \"is_tax_exempt\": true,\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"shipping_address\": {\n    \"same_as_billing\": true,\n    \"address\": {\n      \"city\": \"<string>\",\n      \"country\": \"US\",\n      \"line1\": \"<string>\",\n      \"line2\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\"\n    }\n  },\n  \"vat_number\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v1/customers/{id_or_alias}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"alias\": \"<string>\",\n  \"billing_address\": {\n    \"city\": \"<string>\",\n    \"country\": \"US\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip_code\": \"<string>\"\n  },\n  \"billing_email\": \"<string>\",\n  \"currency\": \"EUR\",\n  \"custom_properties\": \"<unknown>\",\n  \"custom_taxes\": [\n    {\n      \"name\": \"<string>\",\n      \"rate\": \"<string>\",\n      \"tax_code\": \"<string>\"\n    }\n  ],\n  \"invoicing_emails\": [\n    \"<string>\"\n  ],\n  \"invoicing_entity_id\": \"ive_7n42DGM5Tflk9n8mt7Fhc7\",\n  \"is_tax_exempt\": true,\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"shipping_address\": {\n    \"same_as_billing\": true,\n    \"address\": {\n      \"city\": \"<string>\",\n      \"country\": \"US\",\n      \"line1\": \"<string>\",\n      \"line2\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\"\n    }\n  },\n  \"vat_number\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/customers/{id_or_alias}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"alias\": \"<string>\",\n  \"billing_address\": {\n    \"city\": \"<string>\",\n    \"country\": \"US\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip_code\": \"<string>\"\n  },\n  \"billing_email\": \"<string>\",\n  \"currency\": \"EUR\",\n  \"custom_properties\": \"<unknown>\",\n  \"custom_taxes\": [\n    {\n      \"name\": \"<string>\",\n      \"rate\": \"<string>\",\n      \"tax_code\": \"<string>\"\n    }\n  ],\n  \"invoicing_emails\": [\n    \"<string>\"\n  ],\n  \"invoicing_entity_id\": \"ive_7n42DGM5Tflk9n8mt7Fhc7\",\n  \"is_tax_exempt\": true,\n  \"name\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"shipping_address\": {\n    \"same_as_billing\": true,\n    \"address\": {\n      \"city\": \"<string>\",\n      \"country\": \"US\",\n      \"line1\": \"<string>\",\n      \"line2\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\"\n    }\n  },\n  \"vat_number\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "custom_properties": "<unknown>",
  "custom_taxes": [
    {
      "name": "<string>",
      "rate": "<string>",
      "tax_code": "<string>"
    }
  ],
  "id": "<string>",
  "invoicing_emails": [
    "<string>"
  ],
  "invoicing_entity_id": "<string>",
  "name": "<string>",
  "alias": "<string>",
  "billing_address": {
    "city": "<string>",
    "country": "US",
    "line1": "<string>",
    "line2": "<string>",
    "state": "<string>",
    "zip_code": "<string>"
  },
  "billing_email": "<string>",
  "connected_account_id": "<string>",
  "phone": "<string>",
  "shipping_address": {
    "same_as_billing": true,
    "address": {
      "city": "<string>",
      "country": "US",
      "line1": "<string>",
      "line2": "<string>",
      "state": "<string>",
      "zip_code": "<string>"
    }
  },
  "vat_number": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id_or_alias

string

required

customer ID or alias

Body

application/json

alias

string | null

billing_address

object | null

Show child attributes

billing_email

string | null

currency

enum<string> | null

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNH,

CNY,

COP,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STD,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW,

ZWL

Example:

"EUR"

custom_properties

any

Partial update of custom property values (merge; send a key with null to remove it). Omit to leave unchanged.

custom_taxes

object[] | null

Show child attributes

invoicing_emails

string[] | null

invoicing_entity_id

string<MeteroidId> | null

Example:

"ive_7n42DGM5Tflk9n8mt7Fhc7"

is_tax_exempt

boolean | null

name

string | null

phone

string | null

shipping_address

object | null

Show child attributes

vat_number

string | null

Response

Customer

currency

enum<string>

required

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNH,

CNY,

COP,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STD,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW,

ZWL

Example:

"EUR"

custom_properties

any

required

User-defined custom property values, keyed by definition key.

custom_taxes

object[]

required

Show child attributes

string<MeteroidId>

required

Example:

"cus_7n42DGM5Tflk9n8mt7Fhc7"

invoicing_emails

string[]

required

invoicing_entity_id

string<MeteroidId>

required

Example:

"ive_7n42DGM5Tflk9n8mt7Fhc7"

name

string

required

alias

string | null

billing_address

object | null

Show child attributes

billing_email

string | null

connected_account_id

string | null

phone

string | null

shipping_address

object | null

Show child attributes

vat_number

string | null

Archive a customer

List customer entitlements

Add-ons

Batch Jobs

Checkout Sessions

Connect

Coupons

Credit Notes

Custom Properties

Customers

Events

Features

Invoices

Metrics

OAuth Apps

OAuth

Plans

Product Families

Products

Subscriptions

Usage

webhooks

Authorizations

Path Parameters

Body

Response