Limited Release
A billing entity represents a distinct billing configuration within your business that handles billing operations for specific regions, divisions, or legal entities.
Billing entities connect the following:
- 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, you can make a POST call to the Create billing entity endpoint 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.
2. Create billing entity
Use a valid access token and make a POST call to the/v1/commerce/billing/billing-entities endpoint. Include the following parameters:
| Parameter | Action |
|---|---|
nameRequired, string | Provide a descriptive name that identifies the billing entity. |
codeRequired, string | Set a unique code to identify this billing entity. |
default_currencystring | Set the three-letter ISO currency code for the billing entity’s primary currency (for example, USD). See supported currencies. |
finalize_zero_amount_invoiceboolean | Set to true to finalize invoices with zero amounts or false to skip them. |
addressobject | Provide the billing entity’s address with fields: line1, line2, city, state, postal_code, country. |
201 Created response. The response includes the following parameter:
| Parameter | Description | Further action |
|---|---|---|
codestring | Unique code for the billing entity. | Use this code when registering customers or managing the billing entity. |
3. Manage billing entities
To review a billing entity’s current configuration and available management options, make a GET call to the /v1/commerce/billing/billing-entities/ 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 |