Create an addresses for a customer

Create an address for a customer

posthttps://api.paddle.com/customers/{customer_id}/addresses

Creates a new address for a customer.

For tax calculation, fraud prevention, and compliance purposes, you must include a postal_code when creating addresses for some countries. For example, ZIP codes in the USA and postcodes in the UK. See: Supported countries

If successful, your response includes a copy of the new address entity.

Path Parameters

customer_idstringrequired

Paddle ID of the customer entity to work with.

Request Body

country_codestringrequired

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

descriptionstring or null

Memorable description for this address.

first_linestring or null

First line of this address.

second_linestring or null

Second line of this address.

citystring or null

City of this address.

postal_codestring or null

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

regionstring or null

State, county, or region of this address.

custom_dataobject or null

Your own structured key-value data.

Response

dataobject

Represents an address entity.

idstring

Unique Paddle ID for this address entity, prefixed with add_.

customer_idstring

Paddle ID for the customer related to this address, prefixed with cus_.

descriptionstring or null

Memorable description for this address.

first_linestring or null

First line of this address.

second_linestring or null

Second line of this address.

citystring or null

City of this address.

postal_codestring or null

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

regionstring or null

State, county, or region of this address.

country_codestring

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

custom_dataobject or null

Your own structured key-value data.

statusstring

Whether this entity can be used in Paddle.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

import_metaobject or null

Import information for this entity. null if this entity is not imported.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

Request

1
2
3
4
5
6
7
8
1{
2  "description": "Head Office",
3  "first_line": "4050 Jefferson Plaza, 41st Floor",
4  "city": "New York",
5  "postal_code": "10021",
6  "region": "NY",
7  "country_code": "US"
8}

Response