Neynar · Example Payload
Upgrade
Applies a subscription plan change for the current organization and returns the applied credit, charge amount, and whether the change takes effect immediately.
portalsubscription
Upgrade is an example object payload from Neynar, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses
Example Payload
{
"operationId": "upgrade",
"method": "POST",
"path": "/portal/subscription/upgrade",
"summary": "Process subscription upgrade with credit",
"description": "Applies a subscription plan change for the current organization and returns the applied credit, charge amount, and whether the change takes effect immediately.",
"tags": [
"portal",
"subscription"
],
"parameters": [],
"requestBody": {
"required": true,
"schema": {
"properties": {
"newPlan": {
"type": "string"
},
"productCategory": {
"enum": [
"API",
"STUDIO"
],
"type": "string"
}
},
"required": [
"newPlan"
],
"type": "object"
},
"example": null
},
"responses": {
"200": {
"description": "Success",
"schema": {
"properties": {
"chargeAmount": {
"type": "number"
},
"creditApplied": {
"type": "number"
},
"effectiveImmediately": {
"type": "boolean"
},
"newPlan": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [
"success",
"newPlan",
"creditApplied",
"chargeAmount",
"effectiveImmediately"
],
"type": "object"
},
"example": null
},
"400": {
"description": "Bad Request",
"schema": {
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"paymentMethod": {
"properties": {
"brand": {
"type": "string"
},
"last4": {
"type": "string"
}
},
"required": [
"brand",
"last4"
],
"type": "object"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"example": null
},
"401": {
"description": "Unauthorized",
"schema": {
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"paymentMethod": {
"properties": {
"brand": {
"type": "string"
},
"last4": {
"type": "string"
}
},
"required": [
"brand",
"last4"
],
"type": "object"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"example": null
},
"402": {
"description": "Payment Required",
"schema": {
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"paymentMethod": {
"properties": {
"brand": {
"type": "string"
},
"last4": {
"type": "string"
}
},
"required": [
"brand",
"last4"
],
"type": "object"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"example": null
},
"404": {
"description": "Resource not found",
"schema": {
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"paymentMethod": {
"properties": {
"brand": {
"type": "string"
},
"last4": {
"type": "string"
}
},
"required": [
"brand",
"last4"
],
"type": "object"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"example": null
},
"500": {
"description": "Server Error",
"schema": {
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"paymentMethod": {
"properties": {
"brand": {
"type": "string"
},
"last4": {
"type": "string"
}
},
"required": [
"brand",
"last4"
],
"type": "object"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"example": null
}
}
}Work with this as data
Every example here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for examples
4 MCP tools reach this
find_examplesBrowse and filter every example in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This example
curl "https://apis.io/api/v1/examples/upgrade"
All examples
curl "https://apis.io/api/v1/examples?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.