List businesses for a customer
GET {{baseUrl}}/customers/:customer_id/businesses
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.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
after | string | Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations. | |
id | string | Return only the IDs specified. Use a comma-separated list to get multiple entities. | |
order_by | string | Order returned entities by the specified field and direction ([ASC] or [DESC] ). For example, ?order_by=id[ASC] . |
Valid fields for ordering: id
. |
| per_page
| number | | 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
. |
| search
| string | | Return entities that match a search query. |
| status
| string | | Return entities that match the specified status. Use a comma-separated list to specify multiple status values. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |