---
title: "Get a billing entity by code"
method: GET
path: "/billing-entities/{billing_entity_code}"
tags: ["Billing Entities"]
---

# Get a billing entity by code

`GET /billing-entities/{billing_entity_code}`

## Request

- Base URL: `https://api-m.sandbox.paypal.com`
- URL: `https://api-m.sandbox.paypal.com/billing-entities/{billing_entity_code}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/api/oauth-proxy` scopes: `read`, `write`
- TypeScript: <https://skmtc.dev/paypal/apis/usage-based-billing-api/docs/billing-entities/:billing_entity_code/get.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

Billing entity details

- BillingEntityResponse: Base schema for billing entity request/response objects
  - `name` string, required: Name of the billing entity
  - `default_currency` string: Currency code in ISO 4217 format.
  - `finalize_zero_amount_invoice` boolean: Whether to finalize invoices with zero amount
  - `address` Address: Address of the customer or party.
    - `line1` string: First line of the address.
    - `line2` string: Second line of the address (optional). This can include apartment, suite, or unit numbers.
    - `city` string: City of the customer or party.
    - `state` string: State or region of the customer or party.
    - `postal_code` string: Postal or ZIP code of the customer or party. Typically required for countries with a postal code or an equivalent.
    - `country` string: Country of the customer or party. Use ISO 3166-1 alpha-2 country codes.
  - `legal_name` string, nullable: Legal name of the entity
  - `legal_number` string, nullable: Legal registration number
  - `email` string, email, nullable: Contact email for the entity
  - `timezone` string: The timezone of the billing entity
  - `code` string: Unique code used to identify the billing entity. Must contain only alphanumeric characters, underscores, and hyphens.
  - `is_default` boolean: Whether this is the default billing entity
  - `id` string, uuid: The unique identifier for the billing entity
  - `created_at` string, date-time: Creation timestamp
  - `updated_at` string, date-time: Last update timestamp
  - `taxes` TaxResponse[]: List of tax entities configured for the billing entity
    - `name` string, required: Name of the tax
    - `rate` string: 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.
    - `description` string: Detailed description of the tax for internal reference
    - `code` string: Unique code used to identify the tax. Must contain only alphanumeric characters, underscores, and hyphens.
    - `id` string, uuid: Unique identifier of the tax
    - `created_at` string, date-time: The effective start date of the subscription; can be past, current, or future. Date must be provided in ISO 8601 format

## Other responses

- `403`: Authorization failed due to insufficient permissions.
- `404`: Resource Not Found.
- `500`: Internal Server Error - An unexpected error occurred

---

[API](https://skmtc.dev/paypal/apis/usage-based-billing-api.md) - [All operations](https://skmtc.dev/paypal/apis/usage-based-billing-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paypal/apis/usage-based-billing-api/revisions/22fb46514ac4?raw)