- Customers through billing entity code assignment.
- Tax codes for compliance requirements in different jurisdictions.
- Invoices and credit notes that inherit billing entity context.
1. Understand billing entity configuration
Before you create a billing entity, decide on these configuration details based on your business structure and compliance requirements. Then, use the Create billing entity API to send the information to PayPal. Basic identification- Name: Set a descriptive name that identifies the billing entity.
- Code: Create a unique identifier to reference the billing entity in API calls.
- Default currency: Set the primary currency for this billing entity’s operations.
- Invoice settings: Configure whether to finalize invoices with zero amounts.
- Address information: Provide the billing entity’s legal or operational address for compliance and tax purposes.
Ensure you create the billing entity before you assign the tax codes. You cannot assign tax codes during the initial billing entity creation process.
2. Create billing entity
Use a valid access token and send a POST request to/v1/commerce/billing/billing-entities with all required request parameters. On successful billing entity creation, the PayPal server returns a billing entity ID.
Request body parameters
This section documents only a subset of relevant request parameters. For the exhaustive list of request parameters, see API reference.
| Parameter name | Description |
|---|---|
nameRequired, string | Name of the billing entity. |
codeRequired, string | Unique identifier to reference the billing entity in API calls. |
default_currencystring | Three-letter ISO currency code for the billing entity’s primary currency. See supported currencies. |
finalize_zero_amount_invoiceboolean | Determines whether to finalize invoices with zero amounts. Set to true to finalize zero-amount invoices. |
addressobject | Address information for the billing entity with fields: line1, line2, city, state, postal_code, country. |
Response parameters
This section documents only the response parameters relevant for the next step. For the exhaustive list of response fields, see API reference.
| Parameter name | Description and further action |
|---|---|
codestring | Unique code for the billing entity. Use this code in future operations, such as when registering customers or managing the billing entity. |
3. Manage billing entities
To review a billing entity’s current configuration and available management options, call the Get billing entity details endpoint and review the billing entity properties.| Billing entity component | Updatable | Possible management options | Impact on existing customers |
|---|---|---|---|
| Name | Yes | Update billing entity name | No impact - identification only |
| Billing configuration and tax codes | Yes | Update billing entity details - currency, invoice settings, address information, and tax codes | Updates apply to new invoices and operations |
| Billing entity code | No | Billing entity cannot be modified - unique identifier remains permanent | N/A - cannot be modified |