Retrieve current user details | Neon Postgres Docs

GET/users/meRetrieve current user details

Retrieves information about the currently authenticated Neon user, including account identifiers, plan details, and linked auth accounts.

Responses

objectCurrentUserInfoResponse

active_seconds_limitinteger · int64required

Control plane observes active endpoints of a user this amount of wall-clock time.

auth_accountsarray of objectrequired

Authentication provider accounts linked to the current user.

Show child attributes

Show array items

emailstring · emailrequired

Email address associated with this auth account.

maxLength 256 · minLength 1

imagestringrequired

URL of the user's profile picture as provided by the identity provider.

loginstringrequired

Deprecated. Use the `email` field.

namestringrequired

Display name of the account as provided by the identity provider.

providerstringrequired

Identity provider id from keycloak

one of "github", "google", "hasura", "microsoft", "microsoftv2", "vercelmp", "keycloak"

billing_accountobject

Show child attributes

address_citystringrequired

Billing address city.

address_countrystringrequired

Billing address country code defined by ISO 3166-1 alpha-2.

address_country_namestring

Billing address country name.

address_line1stringrequired

Billing address line 1.

address_line2stringrequired

Billing address line 2.

address_postal_codestringrequired

Billing address postal code.

address_statestringrequired

Billing address state or region.

emailstring · emailrequired

Billing email, to receive emails related to invoices and subscriptions.

maxLength 256 · minLength 1

namestringrequired

The full name of the individual or entity that owns the billing account. This name appears on invoices.

orb_portal_urlstring

Orb user portal url

payment_methodstringrequired

Indicates whether and how an account makes payments.

one of "UNKNOWN", "none", "stripe", "direct_payment", "aws_mp", "azure_mp", "vercel_mp", "staff", "trial", "sponsorship", "shared_payment_token"

payment_sourceobjectrequired

Show child attributes

cardobject

Show child attributes

brandstring

Card network reported by the payment processor. Set to `unknown` when the network cannot be determined.

one of "amex", "diners", "discover", "jcb", "mastercard", "unionpay", "unknown", "visa"

exp_monthinteger · int64

Credit card expiration month

exp_yearinteger · int64

Credit card expiration year

last4stringrequired

Last 4 digits of the card.

typestringrequired

Type of payment source. E.g. "card".

plan_detailsobject

Show child attributes

namestringrequired

Plan name, for example `free`, `launch`, or `scale`.

versionobject

Show child attributes

majorintegerrequired

minorintegerrequired

quota_reset_at_laststring · date-timerequired

Timestamp of the last quota reset. Set to the account creation time when the account is first created.

spending_limit_centsinteger | null · int64

Monthly spending cap in cents for V3 paid plans. When set, notifications are sent at 80% and 100% of this limit. `null` means no limit is configured.

statestringrequired

State of the billing account.

one of "UNKNOWN", "active", "suspended", "deactivated", "deleted"

subscription_typestringrequired

Type of subscription to Neon Cloud. Notice that for users without billing account this will be "UNKNOWN"

one of "UNKNOWN", "direct_sales", "direct_sales_v3", "aws_marketplace", "free_v2", "free_v3", "launch", "launch_v3", "scale", "scale_v3", "business", "vercel_pg_legacy"

tax_idstring

The tax identification number for the billing account, displayed on invoices.

tax_id_typestring

The type of the tax identification number based on the country.

branches_limitinteger · int64required

Maximum number of branches allowed for the account under the current plan.

compute_seconds_limitinteger · int64

Maximum Postgres compute time, in seconds, allowed under the account's current plan.

emailstring · emailrequired

Email address of the authenticated user.

maxLength 256 · minLength 1

idstringrequired

The Neon user ID.

imagestringrequired

URL of the user's profile avatar image.

last_namestringrequired

Last name of the current user.

loginstringrequired

Deprecated. Use the `email` field.

max_autoscaling_limitnumber · doublerequired

The maximum autoscaling limit in Compute Units. A value of 0 indicates no limit is configured.

namestringrequired

First name of the current user.

planstringrequired

Current billing plan for the user's account.

projects_limitinteger · int64required

Maximum number of projects the account is allowed to create under the current plan.

Example response

{
  "active_seconds_limit": 0,
  "auth_accounts": [
    {
      "email": "user@example.com",
      "image": "string",
      "login": "string",
      "name": "string",
      "provider": "github"
    }
  ],
  "billing_account": {
    "address_city": "string",
    "address_country": "string",
    "address_country_name": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string",
    "address_state": "string",
    "email": "user@example.com",
    "name": "string",
    "orb_portal_url": "string",
    "payment_method": "UNKNOWN",
    "payment_source": {
      "card": {
        "brand": "amex",
        "exp_month": 0,
        "exp_year": 0,
        "last4": "string"
      },
      "type": "string"
    },
    "plan_details": {
      "name": "string",
      "version": {
        "major": 0,
        "minor": 0
      }
    },
    "quota_reset_at_last": "2026-06-09T00:00:00Z",
    "spending_limit_cents": 0,
    "state": "UNKNOWN",
    "subscription_type": "UNKNOWN",
    "tax_id": "string",
    "tax_id_type": "string"
  },
  "branches_limit": 0,
  "compute_seconds_limit": 0,
  "email": "user@example.com",
  "id": "string",
  "image": "string",
  "last_name": "string",
  "login": "string",
  "max_autoscaling_limit": 0,
  "name": "string",
  "plan": "string",
  "projects_limit": 0
}

defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

curl -X GET 'https://console.neon.tech/api/v2/users/me'

const response = await fetch('https://console.neon.tech/api/v2/users/me', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/users/me', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://console.neon.tech/api/v2/users/me")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://console.neon.tech/api/v2/users/me", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/users/me");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/users/me"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/users/me")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://console.neon.tech/api/v2/users/me");
using var response = await client.SendAsync(request);

{
  "active_seconds_limit": 0,
  "auth_accounts": [
    {
      "email": "user@example.com",
      "image": "string",
      "login": "string",
      "name": "string",
      "provider": "github"
    }
  ],
  "billing_account": {
    "address_city": "string",
    "address_country": "string",
    "address_country_name": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string",
    "address_state": "string",
    "email": "user@example.com",
    "name": "string",
    "orb_portal_url": "string",
    "payment_method": "UNKNOWN",
    "payment_source": {
      "card": {
        "brand": "amex",
        "exp_month": 0,
        "exp_year": 0,
        "last4": "string"
      },
      "type": "string"
    },
    "plan_details": {
      "name": "string",
      "version": {
        "major": 0,
        "minor": 0
      }
    },
    "quota_reset_at_last": "2026-06-09T00:00:00Z",
    "spending_limit_cents": 0,
    "state": "UNKNOWN",
    "subscription_type": "UNKNOWN",
    "tax_id": "string",
    "tax_id_type": "string"
  },
  "branches_limit": 0,
  "compute_seconds_limit": 0,
  "email": "user@example.com",
  "id": "string",
  "image": "string",
  "last_name": "string",
  "login": "string",
  "max_autoscaling_limit": 0,
  "name": "string",
  "plan": "string",
  "projects_limit": 0
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}