List businesses for a customer
Returns a paginated list of businesses for a customer. Use the query parameters to page through results.
By default, Paddle returns businesses that are active. Use the status query parameter to return businesses that are archived.
Path Parameters
Paddle ID of the customer entity to work with.
Query Parameters
Return only the IDs specified. Use a comma-separated list to get multiple entities.
Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.
Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.
Default: 50; Maximum: 200.
Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].
Valid fields for ordering: id.
Return entities that match the specified status. Use a comma-separated list to specify multiple status values.
Return entities that match a search query. Searches all fields, including contacts, except status, created_at, and updated_at.
Response
Represents a business entity.
Unique Paddle ID for this business entity, prefixed with biz_.
Paddle ID for the customer related to this business, prefixed with cus_.
Name of this business.
Company number for this business.
Tax or VAT Number for this business.
Whether this entity can be used in Paddle.
List of contacts related to this business, typically used for sending invoices.
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
Your own structured key-value data.
Import information for this entity. null if this entity is not imported.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
Keys used for working with paginated results.