List businesses for a customer
Changed onReturns 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
- Base URLhttps://sandbox-api.paddle.com
- AuthHTTP bearer
Path parameters
Unique Paddle ID for this customer entity, prefixed with ctm_.
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.
Headers
Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.
Response
The request has succeeded.
Example response
{
"data": [
{
"id": "biz_01grrebrzaee2qj2fqqhmcyzaj",
"customer_id": "ctm_01grnn4zta5a1mf02jjze7y2ys",
"company_number": "123456789",
"tax_identifier": "AB0123456789",
"contacts": [
{
"email": "test@paddle.com"
}
],
"created_at": "2024-10-12T07:20:50.52Z",
"updated_at": "2024-10-13T07:20:50.52Z",
"custom_data": {
"customer_reference_id": "abcd1234"
},
"import_meta": {
"external_id": "9b95b0b8-e10f-441a-862e-1936a6d818ab",
"imported_from": "paddle_classic"
}
}
],
"meta": {
"request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355",
"pagination": {
"estimated_total": 999
}
}
}Changes
- breaking
added the pattern
^ctm_[a-z\d]{26}$to thepathrequest parametercustomer_id - info
added the new optional
headerrequest parameterSkip-Count
- breaking
- breaking
added the new path request parameter
customer_id - breaking
for the
queryrequest parameterstatus, default valueactivewas added - breaking
response property
data/items/company_numberlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
data/items/tax_identifierlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
the
////response property's maxLength was unset from320for the response status - breaking
the
////response property's maxLength was unset from1024for the response status - breaking
the
//response property's maxLength was unset from1024for the response status - breaking
the
////response property's minLength was decreased from1to0for the response status - breaking
the
////response's property type changed fromstringto no type, and format fromemailto no format for status - breaking
the
////response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type, and format fromdate-timeto no format for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type, and format fromdate-timeto no format for status - breaking
the
response's property type changed fromobjectto no type for status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - warning
removed the optional property
/from the response with the status - info
the response optional property
//became not read-only for the status - info
added to the
response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
////response propertyallOflist for the response status - info
added to the
////response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added
subschema #2to the//response propertyanyOflist for the response status - info
added
subschema #2to the//response propertyanyOflist for the response status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
removed the
activeenum value from the//response property for the response status - info
removed the
archivedenum value from the//response property for the response status - info
removed
subschema #2from the//response propertyoneOflist for the response status - info
removed
subschema #2from the//response propertyoneOflist for the response status - info
the
//response's property pattern^ctm_[a-z\d]{26}$was removed for the status - info
the
//response's property pattern^biz_[a-z\d]{26}$was removed for the status
- breaking