---
title: "Get Customer Portal Url"
method: GET
path: "/api/v1/payments/me/customer-portal"
tags: ["User APIs", "payments"]
---

# Get Customer Portal Url

`GET /api/v1/payments/me/customer-portal`

## Query parameters

- `type` 'payment_method_update' | 'subscription_cancel' | 'subscription_update' | 'billing_update' — Type of customer portal session
- `return_url` string, nullable — URL to redirect to after the customer portal session

## Response `200`

Successful Response

- CustomerPortalResponse — Response schema for customer portal session
  - `client_id` string, required — Client ID used for the request
  - `stripe_customer_id` string, required — Stripe customer ID found for the client
  - `session_id` string, required — Stripe customer portal session ID
  - `url` string, required — Customer portal URL
  - `return_url` string, required — Return URL for after the session
  - `customer_id` string, required — Stripe customer ID
  - `created` integer, required — Timestamp when the session was created

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/carbonarc/apis/carbon-arc-client-admin-api.md) · [All operations](https://skmtc.net/carbonarc/apis/carbon-arc-client-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/carbonarc/carbon-arc-client-admin-api/revisions/a8ca30023371/schema)