How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Pay-i

Pay-i Use Cases API

Use Cases

Documentation Provider Profile APIs.io OpenAPI GitHub

Pay-i Use Cases API is one of 14 APIs that Pay-i publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Use Cases. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 12 operations across 7 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.pay-i.com.

12 operations 7 paths 10 schemas 3 DELETE3 GET4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.pay-i.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Pay-i Use Cases API declares 1 security scheme for authenticating requests. An API key is passed in the header as xProxy-api-key (Pay_I_API_Key). By default, every request must be authenticated.

  • Pay_I_API_Key — Pay-I API Key. Example: "{apikey}"

Paths & Operations 12

Across 7 paths, the API surfaces 12 operations — 3 DELETE, 3 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Use Cases 12

Use Cases

GET
/api/v1/use_cases/definitions
Get all Use Cases
getUseCases 4 params → 200400401
POST
/api/v1/use_cases/definitions
Create a new Use Case
createUseCase body → 200201400401403
GET
/api/v1/use_cases/definitions/{use_case_name}
Get Use Case details
getUseCase 1 param → 200400401404
PUT
/api/v1/use_cases/definitions/{use_case_name}
Update a Use Case definition
updateUseCase 1 param body → 200204400401404
DELETE
/api/v1/use_cases/definitions/{use_case_name}
Delete a Use Case
deleteUseCase 1 param → 200400401404
POST
/api/v1/use_cases/definitions/{use_case_name}/increment_version
Increment a Use Case version
incrementUseCaseVersion 1 param → 200400401404
POST
/api/v1/use_cases/definitions/{use_case_name}/limit_config
Create a new Use Case default limit configuration
createUseCaseLimitConfig 1 param body → 200400401404
DELETE
/api/v1/use_cases/definitions/{use_case_name}/limit_config
Delete a Use Case default limit configuration
deleteUseCaseLimitConfig 1 param → 200400401404
GET
/api/v1/use_cases/instances/{use_case_name}/{use_case_id}
Get a Use Case instance details
getUseCaseInstance 2 params → 200400401404
DELETE
/api/v1/use_cases/instances/{use_case_name}/{use_case_id}
Delete a Use Case instance
deleteUseCaseInstance 2 params → 200400401404
POST
/api/v1/use_cases/instances/{use_case_name}
Create a Use Case instance
newUseCaseInstance 1 param → 200400401404
PUT
/api/v1/use_cases/instances/{use_case_name}/{use_case_id}/properties
Update a Use Case instance properties
updateUseCaseInstanceProperties 2 params body → 200400401404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are PayI.Calculator.Models.UseCaseDefinitionResponse (6 properties), PayI.Common.Models.BudgetManagement.CreateLimitBase (4 properties), PayI.Calculator.Models.UseCaseDefinitionRequest (4 properties), PayI.Calculator.Models.UseCaseInstanceResponse (4 properties). Each schema is shown below with its type and property counts.

PayI.Calculator.Models.UpdateUseCaseDefinitionRequest
object
2 properties
PayI.Calculator.Models.UseCaseDefinitionResponse
object
6 properties 3 required
PayI.Common.Models.PropertiesRequest
object
1 property 1 required
PayI.Calculator.Models.ApiQueries.PaginatedCursorUseCaseDefinitionResponseList
object
3 properties
PayI.Common.Models.ApiError
object
3 properties 2 required
PayI.Common.Data.BudgetManagement.Enums.LimitType
string
PayI.Common.Models.ProxyError
object
2 properties
PayI.Calculator.Models.UseCaseDefinitionRequest
object
4 properties 2 required
PayI.Common.Models.BudgetManagement.CreateLimitBase
object
4 properties 1 required
PayI.Calculator.Models.UseCaseInstanceResponse
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pay-i-use-cases-api-openapi.yml Raw ↑

Other APIs Pay-i publishes across the network.

Pay-i Anthropic Requests API
AE Profile APIs.io
Pay-i AWS Bedrock Requests API
AE Profile APIs.io
Pay-i Azure Anthropic Requests API
AE Profile APIs.io
Pay-i Azure OpenAI Requests API
AE Profile APIs.io
Pay-i Categories API
AE Profile APIs.io
Pay-i Google Vertex Requests API
AE Profile APIs.io
Pay-i Ingest Events API
AE Profile APIs.io
Pay-i KP Is API
AE Profile APIs.io
Pay-i Limits API
AE Profile APIs.io
Pay-i OpenAI Requests API
AE Profile APIs.io
Pay-i Reports API
AE Profile APIs.io
Pay-i Requests API
AE Profile APIs.io
#Use Cases
← Back to P APIs
API Details
ID
pay-i:pay-i-use-cases-api
Base URL
https://api.pay-i.com
Docs
https://docs.pay-i.com/reference/getlimits
Provider
Pay-i
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=pay-i-use-cases-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/pay-i-use-cases-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Pay-i Use Cases API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.