Custom data now available
Released on August 12, 2022
Custom data is now available as a checkout parameter (customData). Custom data is structured key value data that you can send to Paddle from the checkout initialization, and have it returned through the lifetime of an order. This is particularly useful for keeping track of data relevant to your own systems or for enabling third party integrations.
You can set customData as a checkout parameter within Paddle.js, and it will be returned in relevant webhook and API payloads with a custom_data key.
What is custom data?
Custom data is similar to the existing passthrough parameter.
Where passthrough only accepts a string, custom data accepts valid structured JSON. This makes it easier for any third parties you may be integrating with Paddle to add metadata to the checkout flow in a standardized way.
How does it work?
To send custom fields to Paddle, you can pass valid structured JSON into the Checkout.Open method call in Paddle.js:
preparing...
The data must be valid JSON, and you must provide at least one key
Custom data in Webhooks
The following webhooks will return the data you've added via custom fields with a custom_data key:
- Order fulfillment webhook
- Subscription created
- Subscription updated
- Subscription payment succeeded
- Subscription payment failed
- Order processing completed
- One off payment succeeded
- High risk transaction created
- High risk transaction updated
Custom data in API Responses
Custom fields will be returned by the following API calls with a custom_data key:
- https://checkout.paddle.com/api/1.0/order
- https://vendors.paddle.com/api/2.0/{entity}/{id}/transactions
- https://vendors.paddle.com/api/2.0/subscription/users
Custom data in the dashboard
We will shortly be adding custom data to the orders page within the dashboard.
Updating Custom data
We do not currently support updating data provided via custom fields. If this is something you need, please let us know.