Docs

Store your own custom data against products and prices

Attach your own key-value data to products and prices in Paddle when working with the API.

Product area

  • Catalog

Tooling

  • API

Released

July 6, 2023

Status

Released

API version

Version 1

What's new?

We updated product and price 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 and subscription entities. Now you can add custom data to products and prices, too.

This is especially powerful because product and price entities are returned by transaction previews. This means you can store data, like a list of features or flags against your products, then use those on pricing pages without needing to store that data yourself.

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.

You can work with products and prices using the API to start adding custom_data to entities.

Summary of changes

Entity Field Change Type
Product custom_data ~ Updated Field
Now writable on create and update.
Price custom_data ~ Updated Field
Now writable on create and update.

Was this page helpful?