See how entities were imported

Get information about how products, prices, discounts, customers, addresses, businesses, and subscriptions were imported.

What's new?

We added a new import_meta object to products, prices, discounts, customers, addresses, businesses, and subscriptions.

import_metaobject

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

external_idstring or null

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

imported_fromstring

Name of the platform where this entity was imported from.

How it works

We're working on import tooling, which will let you import data from Paddle Classic or other platforms in the future.

In preparation for this, we added a new import_meta object to products, prices, discounts, customers, addresses, businesses, and subscriptions.

Where an entity is imported, this object returns information about the import. It's null for entities that aren't imported.

Sign up for developer changelog email updates to be the first to know when we're ready to launch import tooling.

Summary of changes to fields

This is a summary of the changes to fields in the Paddle API and webhooks:

Field	Change
`product.import_meta`	New field
`price.import_meta`	New field
`discount.import_meta`	New field
`customer.import_meta`	New field
`business.import_meta`	New field
`address.import_meta`	New field
`subscription.import_meta`	New field

Example

This is a response for the get a customer operation for a customer that was imported.

import_meta is an object that includes information about the imported entity.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
1{
2  "data": {
3    "id": "ctm_01hrffh7gvp29kc7xahm8wddwa",
4    "status": "active",
5    "custom_data": null,
6    "name": "Sam Miller",
7    "email": "sam@example.com",
8    "marketing_consent": false,
9    "locale": "en",
10    "created_at": "2024-03-08T16:49:53.691Z",
11    "updated_at": "2024-04-11T16:03:57.924146Z",
12    "import_meta": null
13  },
14  "meta": {
15    "request_id": "aa0009cb-18f7-4538-b1cd-ad29d91cfaa7"
16  }
17}

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.

Learn more

Paddle API

subscription.imported event