---
title: "Get an embeddable URL to the customer portal"
method: GET
path: "/customers/{external_customer_id}/portal_url"
tags: ["Customers"]
---

# Get an embeddable URL to the customer portal

`GET /customers/{external_customer_id}/portal_url`

## Request

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

## Path parameters

- `external_customer_id` string, required

## Response `200`

Embeddable URL to the Customer Portal for the given external customer ID is returned.

- CustomerPortalEmbeddableUrlResponse
  - `url` string
  - `expires_in` integer

## Other responses

- `400`: Bad Request - Invalid input data
- `403`: Authorization failed due to insufficient permissions.
- `409`: Conflict - The request could not be completed due to a conflict with the current state of the resource.
- `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)