Skip to main content
PUT
/
billing-entities
/
{billing_entity_code}
Update a billing entity by code
curl --request PUT \
  --url https://api-m.sandbox.paypal.com/v1/commerce/billing/billing-entities/{billing_entity_code} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Inc",
  "default_currency": "USD",
  "finalize_zero_amount_invoice": true,
  "address": {
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001",
    "country": "US"
  },
  "legal_name": "Acme Corporation Inc.",
  "legal_number": "US123456789",
  "email": "[email protected]",
  "timezone": "UTC",
  "tax_codes": [
    "standard_vat"
  ]
}
'
{
  "id": "b8e2a656-04eb-441c-a6b2-bfab9e2a0f7c",
  "code": "acme_inc",
  "name": "Acme Inc (Updated)",
  "default_currency": "USD",
  "finalize_zero_amount_invoice": true,
  "is_default": true,
  "address": {
    "line1": "123 Business Ave, Suite 500",
    "line2": "Floor 5",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "postal_code": "94107"
  },
  "legal_name": "Acme Corporation Inc. LLC",
  "legal_number": "US987654321",
  "email": "[email protected]",
  "timezone": "America/Los_Angeles",
  "created_at": "2023-01-15T00:00:00Z",
  "updated_at": "2023-01-16T05:30:00Z",
  "taxes": [
    {
      "id": "d4e3c878-16fd-663e-c8d4-dgab0f4c2g9e",
      "name": "California State Sales Tax",
      "code": "us_ca_sales_tax_8_25",
      "description": "California State Sales Tax",
      "rate": "8.25",
      "created_at": "2023-01-15T00:00:00Z"
    },
    {
      "id": "e5f4d989-27ge-774f-d9e5-ehbc1g5d3h0f",
      "name": "San Francisco City Tax",
      "code": "us_sf_city_tax_1_25",
      "description": "San Francisco City Tax",
      "rate": "1.25",
      "created_at": "2023-01-16T05:30: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.

Path Parameters

​
billing_entity_code
string
required

Unique code identifier of the billing entity

Body

application/json

Request body for updating an existing billing entity

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

"[email protected]"

​
timezone
string

The timezone of the billing entity

Example:

"UTC"

​
tax_codes
string[]

List of unique codes used to identify taxes to be applied.

Example:
["standard_vat"]

Response

Billing entity updated successfully

Response object for billing entity operations

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

"[email protected]"

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

Creation timestamp

Example:

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

​
updated_at
string<date-time>

Last update timestamp

Example:

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

​
taxes
object[]

List of tax entities configured for the billing entity