Skip to main content
GET
/
billing-entities
List all billing entities
curl --request GET \
  --url https://api-m.sandbox.paypal.com/v1/commerce/billing/billing-entities \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "b8e2a656-04eb-441c-a6b2-bfab9e2a0f7c",
    "code": "acme_inc",
    "name": "Acme Inc",
    "default_currency": "USD",
    "finalize_zero_amount_invoice": true,
    "is_default": true,
    "address": {
      "line1": "123 Business Ave",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "postal_code": "94107"
    },
    "legal_name": "Acme Corporation Inc.",
    "legal_number": "US123456789",
    "email": "billing@acmeinc.com",
    "timezone": "America/Los_Angeles",
    "created_at": "2023-01-15T00:00:00Z",
    "updated_at": "2023-01-15T00:00:00Z"
  },
  {
    "id": "c9f3b767-15fc-552d-b7c3-cfab0f3b1f8d",
    "code": "acme_eu",
    "name": "Acme Europe",
    "default_currency": "EUR",
    "finalize_zero_amount_invoice": true,
    "is_default": false,
    "address": {
      "line1": "456 Business Blvd",
      "city": "Paris",
      "country": "FR",
      "postal_code": "75001"
    },
    "legal_name": "Acme Corporation SARL",
    "legal_number": "FR987654321",
    "email": "europe-billing@acmeinc.com",
    "timezone": "Europe/Paris",
    "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.

Response

List of billing entities

Array of billing entities

​
name
string
required

Name of the billing entity

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"

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