Skip to main content
GET
/
customers
/
{customer_id}
/
businesses
List businesses for a customer
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paddle.com/customers/{customer_id}/businesses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": [
    {
      "id": "biz_01hv8j0z17hv4ew8teebwjmfcb",
      "status": "active",
      "customer_id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4",
      "name": "HighFly LLC.",
      "company_number": "555829503785",
      "tax_identifier": "555810433",
      "contacts": [
        {
          "name": "Blair Lopez",
          "email": "[email protected]"
        }
      ],
      "custom_data": null,
      "created_at": "2024-04-12T07:05:50.887Z",
      "updated_at": "2024-04-12T07:05:50.887Z",
      "import_meta": null
    },
    {
      "id": "biz_01hv8hkr641vmpwytx38znv56k",
      "status": "active",
      "customer_id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4",
      "name": "Uplift Inc.",
      "company_number": "555775291485",
      "tax_identifier": "555952383",
      "contacts": [
        {
          "name": "Parker Jones",
          "email": "[email protected]"
        },
        {
          "name": "Jo Riley",
          "email": "[email protected]"
        },
        {
          "name": "Jesse Garcia",
          "email": "[email protected]"
        }
      ],
      "custom_data": {
        "crm_id": "eb9b8d9b-7dd6-48e6-8c39-8557bba5eaa9"
      },
      "created_at": "2024-04-12T06:58:37.892Z",
      "updated_at": "2024-04-12T07:01:03.510528Z",
      "import_meta": null
    }
  ],
  "meta": {
    "request_id": "ec0cc200-3610-4726-a374-a2df142baff8",
    "pagination": {
      "per_page": 50,
      "next": "https://api.paddle.com/customers/ctm_01hv6y1jedq4p1n0yqn5ba3ky4/businesses?after=biz_01hv8hkr641vmpwytx38znv56k",
      "has_more": false,
      "estimated_total": 2
    }
  }
}

Authorizations

​
Authorization
string
header
required

Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.

API keys are assigned permissions, granting them access to entities and operations. Each endpoint may require one or more permissions, defined with the x-permissions extension. Values for include parameters may require specific permissions as defined in the x-enum-permissions extension. See all available permissions in the permission schema or documentation.

Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.

Path Parameters

​
customer_id
string
required

Paddle ID of the customer entity to work with.

Example:

"ctm_01gw1xk43eqy2rrf0cs93zvm6t"

Query Parameters

​
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
default:id[DESC]

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
integer
default:50

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.

Required range: x <= 200
​
search
string

Return entities that match a search query. Searches all fields, including contacts, except status, created_at, and updated_at.

Maximum string length: 100
Example:

"upgrade"

​
status
enum<string>[]

Return entities that match the specified status. Use a comma-separated list to specify multiple status values.

Available options:
active,
archived

Response

OK

​
data
Business · object[]
required
​
meta
MetaPaginated · object
required

Information about this response.