Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.neynar.com/llms.txt

Use this file to discover all available pages before exploring further.

Get upgrade preview with credit calculation
Group: Subscription APIs
Use this when you need: Get upgrade preview with credit calculation.

​
Usage

import { NeynarAPIClient, Configuration } from "@neynar/nodejs-sdk";

const client = new NeynarAPIClient(
  new Configuration({ apiKey: "YOUR_NEYNAR_API_KEY" })
);

const res = await client.upgradePreview({
  newPlan: "example", // required
  // productCategory: "value", 
});
console.log(res);

​
Parameters

ParameterTypeRequiredDescription
newPlanstring✅-
productCategoryUpgradePreviewProductCategoryEnum❌-

​
Response

Returns a RequestArgs object.

​
Error Handling

try {
  const res = await client.upgradePreview({
    newPlan: "example"
  });
  // use res
} catch (err) {
  // Axios/HTTP errors, invalid params, auth issues, etc.
  console.error(err);
}

​
Tips

  • Provide a viewerFid when supported to respect mutes/blocks and include viewer_context.
  • Keep requests scoped (e.g., use limit) to improve latency.
  • Cache results where sensible.