PApaypal
Billing Entities

Update a billing entity by code

put/billing-entities/{billing_entity_code}

Request

Request body

namestring required

Name of the billing entity

default_currencystring

Currency code in ISO 4217 format.

finalize_zero_amount_invoiceboolean

Whether to finalize invoices with zero amount

legal_namestring nullable

Legal name of the entity

legal_numberstring nullable

Legal registration number

emailstring email nullable

Contact email for the entity

timezonestring

The timezone of the billing entity

tax_codesstring[]

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

Example request

{
  "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": "billing@acmeinc.com",
  "timezone": "UTC",
  "tax_codes": [
    "standard_vat"
  ]
}

Response

Billing entity updated successfully

namestring required

Name of the billing entity

default_currencystring

Currency code in ISO 4217 format.

finalize_zero_amount_invoiceboolean

Whether to finalize invoices with zero amount

legal_namestring nullable

Legal name of the entity

legal_numberstring nullable

Legal registration number

emailstring email nullable

Contact email for the entity

timezonestring

The timezone of the billing entity

codestring

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

is_defaultboolean

Whether this is the default billing entity

idstring uuid

The unique identifier for the billing entity

created_atstring date-time

Creation timestamp

updated_atstring date-time

Last update timestamp

Example response

{
  "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": "billing@acmeinc.com",
  "timezone": "UTC",
  "code": "acme_inc",
  "id": "b8e2a656-04eb-441c-a6b2-bfab9e2a0f7c",
  "created_at": "2023-01-15T00:00:00Z",
  "updated_at": "2023-01-15T00:00:00Z",
  "taxes": [
    {
      "name": "TVA",
      "rate": "20.00",
      "description": "French standard VAT",
      "code": "standard_vat",
      "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "created_at": "2025-06-01T00:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.