Paddle IDs are unique identifiers for entities in Paddle. They easily identifiable by type and lexicographically sortable.
Every entity in Paddle has a unique identifier, called a Paddle ID. Paddle IDs are made up of a prefix for the kind of entity, followed by a unique string of alphanumeric characters.
Prefixes are typically three characters, but may be longer. They're distinctive, so it's easy to tell what kind of entity you're working with when using a Paddle ID.
For example, here are some common Paddle IDs:
Paddle automatically generates IDs for you when you create entities using the API or dashboard. Use Paddle IDs to refer to entities throughout the Paddle platform.
When creating entities using the API, Paddle returns the new Paddle ID for the entity in the response.
When reading, updating, or deleting entities, use the ID to refer to the correct entity. For example:
Paddle ID of the product to get.
When working with list endpoints, Paddle uses the Paddle ID of the entity you're working with as the cursor for pagination.
Return entities after the specified cursor.
Paddle ID of the product to use as the cursor.
Where entities are related, use Paddle IDs to link them. For example:
- When creating a price, pass a
product_idto set the product that a price relates to.
- When creating a transaction, pass a
address_idto set who to bill.
- When the
subscription.createdevent occurs, it includes the
transaction_idof the transaction that resulted in this subscription being created.
Paddle IDs are lexicographically sortable. Sorting by Paddle ID results in the same order as sorting by the creation date of an entity.