Skip to main content
POST
/
customers
/
{customer_id}
/
addresses
Create an address for a customer
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: 'Head Office',
    first_line: '4050 Jefferson Plaza, 41st Floor',
    city: 'New York',
    postal_code: '10021',
    region: 'NY',
    country_code: 'US'
  })
};

fetch('https://api.paddle.com/customers/{customer_id}/addresses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "add_01hv8gq3318ktkfengj2r75gfx",
    "status": "active",
    "customer_id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4",
    "description": "Head Office",
    "first_line": "4050 Jefferson Plaza, 41st Floor",
    "second_line": null,
    "city": "New York",
    "postal_code": "10021",
    "region": "NY",
    "country_code": "US",
    "custom_data": null,
    "created_at": "2024-04-12T06:42:58.785Z",
    "updated_at": "2024-04-12T06:42:58.785Z",
    "import_meta": null
  },
  "meta": {
    "request_id": "dd6bbb71-6551-4e4a-843c-b10611cddb6e"
  }
}

Authorizations

Authorization
string
header
required

Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.

API keys are assigned permissions, granting them access to entities and operations. Each endpoint may require one or more permissions, defined with the x-permissions extension. Values for include parameters may require specific permissions as defined in the x-enum-permissions extension. See all available permissions in the permission schema or documentation.

Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.

Path Parameters

customer_id
string
required

Paddle ID of the customer entity to work with.

Example:

"ctm_01gw1xk43eqy2rrf0cs93zvm6t"

Body

application/json

Represents an address entity when creating addresses.

country_code
enum<string>
required

Supported two-letter ISO 3166-1 alpha-2 country code for this address.

Available options:
AD,
AE,
AG,
AI,
AL,
AM,
AO,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BV,
BW,
BZ,
CA,
CC,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RW,
SA,
SB,
SC,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SR,
ST,
SV,
SX,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
UY,
UZ,
VA,
VC,
VG,
VI,
VN,
VU,
WF,
WS,
XK,
YT,
ZA,
ZM
description
string | null

Memorable description for this address.

Maximum string length: 1024
Example:

"Paddle.com"

first_line
string | null

First line of this address.

Maximum string length: 1024
Example:

"3811 Ditmars Blvd"

second_line
string | null

Second line of this address.

Maximum string length: 1024
city
string | null

City of this address.

Maximum string length: 200
Example:

"Astoria"

postal_code
string | null

ZIP or postal code of this address. Required for some countries.

Maximum string length: 200
Example:

"11105-1803"

region
string | null

State, county, or region of this address.

Maximum string length: 200
Example:

"NY"

custom_data
Custom data · object

Your own structured key-value data.

Example:
{ "customer_reference_id": "abcd1234" }

Response

Created

data
Address · object
required

Represents an address entity.

meta
Meta · object
required

Information about this response.