Skip to main content
POST
/
billing-entities
Create a billing entity
curl --request POST \
  --url https://api-m.paypal.com/v1/commerce/billing/billing-entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Acme Inc",
  "code": "acme_inc"
}'
{
  "id": "e7f4c956-23fc-663d-a8c3-egcb1f5d4h0e",
  "code": "acme_west",
  "name": "Acme Western Division",
  "default_currency": "USD",
  "finalize_zero_amount_invoice": true,
  "is_default": false,
  "address": {
    "line1": "789 Tech Boulevard",
    "line2": "Suite 1200",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "postal_code": "94107"
  },
  "legal_name": "Acme Corporation Western LLC",
  "legal_number": "US87654321",
  "tax_identification_number": "87-6543210",
  "email": "west-billing@acmeinc.com",
  "timezone": "America/Los_Angeles",
  "created_at": "2023-01-15T00:00:00Z",
  "updated_at": "2023-01-15T00:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Use the /v1/oauth2/token endpoint to obtain an access token and pass it as a Bearer token in the Authorization header.

Body

application/json

Request body for creating a new billing entity Base schema for billing entity request/response objects

​
name
string
required

Name of the billing entity

Example:

"Acme Inc"

​
code
string
required

Unique code used to identify the billing entity. Must contain only alphanumeric characters, underscores, and hyphens.

Example:

"acme_inc"

​
default_currency
string

Currency code in ISO 4217 format.

Required string length: 3
Example:

"USD"

​
finalize_zero_amount_invoice
boolean

Whether to finalize invoices with zero amount

Example:

true

​
address
object

Address of the customer or party.

​
legal_name
string | null

Legal name of the entity

Example:

"Acme Corporation Inc."

​
legal_number
string | null

Legal registration number

Example:

"US123456789"

​
tax_identification_number
string | null

Tax identification number

Example:

"123-45-6789"

​
email
string<email> | null

Contact email for the entity

Example:

"billing@acmeinc.com"

​
timezone
string

The timezone of the billing entity

Example:

"UTC"

Response

Billing entity created successfully

Response object for billing entity operations A billing entity with associated tax details Represents a billing entity which can be associated with invoices, customers, and taxes Base schema for billing entity request/response objects

​
name
string
required

Name of the billing entity

Example:

"Acme Inc"

​
taxes
object[]

List of tax entities configured for the billing entity

​
default_currency
string

Currency code in ISO 4217 format.

Required string length: 3
Example:

"USD"

​
finalize_zero_amount_invoice
boolean

Whether to finalize invoices with zero amount

Example:

true

​
address
object

Address of the customer or party.

​
legal_name
string | null

Legal name of the entity

Example:

"Acme Corporation Inc."

​
legal_number
string | null

Legal registration number

Example:

"US123456789"

​
tax_identification_number
string | null

Tax identification number

Example:

"123-45-6789"

​
email
string<email> | null

Contact email for the entity

Example:

"billing@acmeinc.com"

​
timezone
string

The timezone of the billing entity

Example:

"UTC"

​
code
string

Unique code used to identify the billing entity. Must contain only alphanumeric characters, underscores, and hyphens.

Example:

"acme_inc"

​
is_default
boolean

Whether this is the default billing entity

Example:

false

​
id
string<uuid>

The unique identifier for the billing entity

Example:

"b8e2a656-04eb-441c-a6b2-bfab9e2a0f7c"

​
created_at
string<date-time>

Date and time in ISO 8601 format. Creation timestamp

Example:

"2023-01-15T00:00:00Z"

​
updated_at
string<date-time>

Date and time in ISO 8601 format. Last update timestamp

Example:

"2023-01-15T00:00:00Z"

⌘I