Businesses

Get a business for a customer

Changed on

Returns a business for a customer using its ID and related customer ID.

get/customers/{customer_id}/businesses/{business_id}

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Path parameters

business_idstring required

Paddle ID of the business entity to work with.

customer_idstring required

Unique Paddle ID for this customer entity, prefixed with ctm_.

Example:ctm_01grnn4zta5a1mf02jjze7y2ys

Paddle ID of the customer entity to work with.

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"
  }
}

Changes

    • breaking

      added the pattern ^ctm_[a-z\d]{26}$ to the path request parameter customer_id

    • breaking

      added the new path request parameter business_id

    • breaking

      added the new path request parameter customer_id

    • breaking

      response property data/company_number list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/tax_identifier list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the /// response property's maxLength was unset from 320 for the response status

    • breaking

      the /// response property's maxLength was unset from 1024 for the response status

    • breaking

      the / response property's maxLength was unset from 1024 for the response status

    • breaking

      the /// response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the /// response's property type changed from string to no type, and format from email to no format for status

    • breaking

      the /// response's property type changed from string to no type for status

    • breaking

      the / response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the / response's property type changed from string to no type for status

    • breaking

      the / response's property type changed from string to no type for status

    • breaking

      the / response's property type changed from string to no type for status

    • breaking

      the / response's property type changed from string to no type for status

    • breaking

      the / response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the response's property type changed from object to 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 property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the /// response property allOf list for the response status

    • info

      added to the /// response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added subschema #2 to the / response property anyOf list for the response status

    • info

      added subschema #2 to the / response property anyOf list 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 active enum value from the / response property for the response status

    • info

      removed the archived enum value from the / response property for the response status

    • info

      removed subschema #2 from the / response property oneOf list for the response status

    • info

      removed subschema #2 from the / response property oneOf list 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