Addresses

Address entities hold billing address information for a customer. They're subentities of customers.

Addresses store components of a customer billing address. They're always created against a customer entity.

You can create as many addresses as you like against a customer — useful for billing companies with different locations.

Address entities hold address components like:

Country.
ZIP/postal code.
State or region.
A short, internal description for this address.

Customers, addresses, and businesses work with checkouts, transactions, and subscriptions to let customers purchase products and prices.

Customers require an address to make a purchase. To make buying as frictionless as possible, Paddle only requires a country except in some regions where a ZIP or postal code is also required.

There's no delete operation for addresses. Use the update an address operation to archive addresses when you no longer need them. To learn more, see Delete entities

Create or update a customer

Supported countries

Attributes

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.

imported_fromstring

Name of the platform where this entity was imported from.

external_idstring or null

Reference or identifier for this entity from the solution where it was imported from.

List addresses for a customer

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

Create an addresses for a customer

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

Get an address for a customer

gethttps://api.paddle.com/customers/{customer_id}/addresses/{address_id}

Update an address for a customer

patchhttps://api.paddle.com/customers/{customer_id}/addresses/{address_id}