Match webhooks for addresses and businesses to customers
Updated address and business notifications make it easier to work with addresses and businesses for a customer in the API.
What's new?
We updated the address and business entities in the Paddle API and webhooks so that they include the related customer_id
.
How it works
Customers in Paddle are modular. Each customer entity can be related to one or more address and business entities. Addresses and businesses are subentities, meaning you need the Paddle ID for a customer to work with an address or business in the API. For example, to update an address for a customer you need both the Paddle ID for the customer entity and the address entity:
Paddle ID of the customer entity to work with.
Paddle ID of the customer entity to work with.
When you receive a webhook for an address or business event, the data payload mirrors the entity in the Paddle API. Since it doesn't include the Paddle ID of the related customer, previously you couldn't immediately work with the address or business in the API. You'd need to store the Paddle ID of the customer for an address on your side.
With this update, we added customer_id
to address and business entities in the Paddle API and webhooks. Webhooks for addresses and businesses now include all the information you need to work with them in the Paddle API.
Summary of changes
This is a summary of the changes to fields in the Paddle API and webhooks:
Field | Change |
---|---|
address.customer_id | New |
business.customer_id | New |
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.