Businesses

Business entities hold information about customer businesses. They're sub-entities of customers.

Businesses store information that you need when working with a business rather than an individual. They're always created against a customer entity.

You can create as many addresses as you like against a customer — useful for billing companies with different legal entities.

Businesses hold information like:

What the company is called
Company number and tax number
Who should be contacted at the company

Customers, addresses, and businesses work with checkouts, transactions, and subscriptions to bill for products and prices.

You don't need to create a business to bill a customer. You only need one when working with a business.

Learn how to create a complete customer with a related address and business. See: Work with customers

There's no delete operation for businesses. Use the update a business operation to archive businesses when you no longer need them. See: Delete entities

Attributes

idstring

Unique Paddle ID for this business entity, prefixed with biz_.

customer_idstring

Paddle ID for the customer related to this business, prefixed with cus_.

namestring

Name of this business.

company_numberstring or null

Company number for this business.

tax_identifierstring or null

Tax or VAT Number for this business.

statusstring

Whether this entity can be used in Paddle.

contactsarray[object]

List of contacts related to this business, typically used for sending invoices.

namestring

Full name of this contact.

emailstring<email>

Email address for this contact.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

custom_dataobject or null

Your own structured key-value data.

import_metaobject or null

Import information for this entity. null if this entity is not imported.

external_idstring or null

Reference or identifier for this entity from the solution where it was imported from.

imported_fromstring

Name of the platform where this entity was imported from.

List businesses for a customer

gethttps://api.paddle.com/customers/{customer_id}/businesses

Create a business for a customer

posthttps://api.paddle.com/customers/{customer_id}/businesses

Get a business for a customer

gethttps://api.paddle.com/customers/{customer_id}/businesses/{business_id}

Update a business for a customer

patchhttps://api.paddle.com/customers/{customer_id}/businesses/{business_id}