Docs

Store your own custom data against customers, addresses, and businesses

Attach your own key-value data to customers, addresses, and businesses in Paddle when working with the API.

Product area

  • Customers

Tooling

  • API

Released

September 21, 2023

Status

Released

API version

Version 1

What's new?

We updated customer, address, and business entities so that now you can add custom_data when creating or updating them.

custom_data object

Your own structured key-value data

How it works

Custom data lets you add your own key-value data entities created using Paddle Checkout or the API. Once added, you can see custom data in API responses and webhooks for an entity.

Previously, you could add custom data to transaction, subscription, product, and price entities. Now you can add custom data to customer, address, and business entities, too.

This is especially useful if you're using the API or webhooks to sync with a CRM or ERP solution. You can store identifiers or other data from your third-party solution against related entities in Paddle.

Next steps

This change is available in version 1 of the Paddle API.

It's a non-breaking change, meaning it doesn't impact existing integrations.

Create or update customers, addresses, and businesses using the API to get started.

Summary of changes

Entity Field Change Type
Customer custom_data ~ Updated Field
Now writable on create and update.
Address custom_data ~ Updated Field
Now writable on create and update.
Business custom_data ~ Updated Field
Now writable on create and update.

Was this page helpful?