BillingEntityResponse

Response object for billing entity operations

namestringRequired

Name of the billing entity

default_currencystring<Currency>Optional

Currency code in ISO 4217 format.

Match^[A-Z]{3}$Length3 <= length <= 3

finalize_zero_amount_invoicebooleanOptional

Whether to finalize invoices with zero amount

addressobject<Address>Optional

Address of the customer or party.

Address properties

6 properties

line1stringOptional

First line of the address.

Length1 <= length <= 254

line2stringOptional

Second line of the address (optional). This can include apartment, suite, or unit numbers.

Length1 <= length <= 512

citystringOptional

City of the customer or party.

Length1 <= length <= 512

statestringOptional

State or region of the customer or party.

Length1 <= length <= 512

postal_codestringOptional

Postal or ZIP code of the customer or party. Typically required for countries with a postal code or an equivalent.

Length1 <= length <= 512

countrystringOptional

Country of the customer or party. Use ISO 3166-1 alpha-2 country codes.

Match^[A-Z]{2}$Length2 <= length <= 2

legal_namestring | nullOptional

Legal name of the entity

legal_numberstring | nullOptional

Legal registration number

emailstring | nullOptional

Contact email for the entity

Formatemail

timezonestring<Timezone>Optional

The timezone of the billing entity

codestring<BillingEntityCode>Optional

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

Match^[a-zA-Z0-9_-]*$

is_defaultbooleanOptional

Whether this is the default billing entity

idstringOptional

The unique identifier for the billing entity

Formatuuid

created_atstring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

updated_atstring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

taxesobject<TaxResponse>[]Optional

List of tax entities configured for the billing entity

TaxResponse properties

6 properties

namestringRequired

Name of the tax

ratestringOptional

The percentage rate of the tax applied to transactions. A decimal amount from 0.01 to 100.00 inclusive, always with exactly two decimal places, no leading zeros except 0.xx.

Match^(?!0+(?:\.0+)?$)(?:0?\.\d{1,2}|[1-9]\d?(?:\.\d{1,2})?|100(?:\.0{1,2})?)$

descriptionstringOptional

Detailed description of the tax for internal reference

codestring<TaxCode>Optional

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

Match^[a-zA-Z0-9_-]*$

idstringOptional

Unique identifier of the tax

Formatuuid

created_atstring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

Response object for billing entity operations

namestringRequired

Name of the billing entity

default_currencystring<Currency>Optional

Currency code in ISO 4217 format.

Match^[A-Z]{3}$Length3 <= length <= 3

finalize_zero_amount_invoicebooleanOptional

Whether to finalize invoices with zero amount

addressobject<Address>Optional

Address of the customer or party.

Address properties

6 properties

line1stringOptional

First line of the address.

Length1 <= length <= 254

line2stringOptional

Second line of the address (optional). This can include apartment, suite, or unit numbers.

Length1 <= length <= 512

citystringOptional

City of the customer or party.

Length1 <= length <= 512

statestringOptional

State or region of the customer or party.

Length1 <= length <= 512

postal_codestringOptional

Postal or ZIP code of the customer or party. Typically required for countries with a postal code or an equivalent.

Length1 <= length <= 512

countrystringOptional

Country of the customer or party. Use ISO 3166-1 alpha-2 country codes.

Match^[A-Z]{2}$Length2 <= length <= 2

legal_namestring | nullOptional

Legal name of the entity

legal_numberstring | nullOptional

Legal registration number

emailstring | nullOptional

Contact email for the entity

Formatemail

timezonestring<Timezone>Optional

The timezone of the billing entity

codestring<BillingEntityCode>Optional

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

Match^[a-zA-Z0-9_-]*$

is_defaultbooleanOptional

Whether this is the default billing entity

idstringOptional

The unique identifier for the billing entity

Formatuuid

created_atstring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

updated_atstring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

taxesobject<TaxResponse>[]Optional

List of tax entities configured for the billing entity

TaxResponse properties

6 properties

namestringRequired

Name of the tax

ratestringOptional

The percentage rate of the tax applied to transactions. A decimal amount from 0.01 to 100.00 inclusive, always with exactly two decimal places, no leading zeros except 0.xx.

Match^(?!0+(?:\.0+)?$)(?:0?\.\d{1,2}|[1-9]\d?(?:\.\d{1,2})?|100(?:\.0{1,2})?)$

descriptionstringOptional

Detailed description of the tax for internal reference

codestring<TaxCode>Optional

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

Match^[a-zA-Z0-9_-]*$

idstringOptional

Unique identifier of the tax

Formatuuid

created_atstring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

BillingEntityResponse

Address properties

TaxResponse properties

Back to top

On this page

On this page

BillingEntityResponse

Address properties

TaxResponse properties

Back to top

On this page

BillingEntityResponse

Address properties

TaxResponse properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

BillingEntityResponse

Address properties

TaxResponse properties

Back to top

On this page