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

fetch('https://api.paddle.com/customers/{customer_id}/businesses/{business_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "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": "2889a1a0-2844-4a1a-a7f1-81f5c82d5433"
  }
}

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"

business_id
string
required

Paddle ID of the business entity to work with.

Example:

"biz_01gvcz4m28csa5kem2gqq5ymxn"

Response

OK

data
Business · object
required

Represents a business entity.

meta
Meta · object
required

Information about this response.