Payment Plans give AI Builders the ability to control how and when users can use an AI Agent or service. They are entirely controlled and managed by the AI Builder that creates them with no interference from Nevermined.Nevermined Payment Plans enable time-based or request-based gating of an AI Agent.
Provides user access with per-request pricing. Builders can manage the cost per request to access their AI service. This is done by setting the price to purchase a bundle of credits and the number of credits redeemed for each request (call onfigured during Plan creation). Each time a request is made, user credits are validated and redeemed. If the user does not have enough credits, they will be prompted to purchase more and denied access until they do so.
Copy
Ask AI
// This is the USDC ERC20 address in the test network (sandbox) const USDC_ERC20_TESTING = '0x036CbD53842c5426634e7929541eC2318f3dCF7e'const planMetadata = { name: 'My Credits Plan', tags: ['test']}// The price is 20 USDC (20_000_000) in the sandbox networkconst priceConfig = getERC20PriceConfig(20_000_000n, USDC_ERC20_TESTING, builderAddress)// The subscriber receives 100 credits upon purchasing the planconst creditsConfig = getFixedCreditsConfig(100n)// Register the planconst { planId } = await payments.plans.registerCreditsPlan( planMetadata, priceConfig, creditsConfig)
Provides user access on a time-gating basis. Builders can set the time period that a user is allowed access to the AI (e.g. 1 year, 1 month, 1 hour, etc.). When a user makes their first request, the corresponding access credit is redeemed, granting access for the designated period. Once the time period has elapsed, the user will no longer have access and will need to redeem another credit for continued access.
Copy
Ask AI
// The price is 5 USDC (5_000_000) in the sandbox networkconst priceConfig = getERC20PriceConfig(5_000_000n, ERC20_ADDRESS, builderAddress)// The plan is valid for 1 dayconst oneDayPlanConfig = getExpirableDurationConfig(ONE_DAY_DURATION)// Register the planconst { planId } = await payments.plans.registerTimePlan( planMetadata, priceConfig, oneDayPlanConfig)
A Trial Plan is a special type of Payment Plan that allows users to try out an AI Agent for a limited time (typically for free). A Trial Plan can only be obtained once by each user.
Copy
Ask AI
const trialPlanMetadata: PlanMetadata = { name: 'Try it for one day before you buy it',}// The price is freeconst freeConfig = getFreePriceConfig()// The plan is valid for 1 dayconst oneDayPlanConfig = getExpirableDurationConfig(ONE_DAY_DURATION)// Register the trial planconst { planId } = await payments.plans.registerTimeTrialPlan( trialPlanMetadata, freeConfig, oneDayPlanConfig)
When you register an Agent, you need to provide the API endpoints for accessing the AI Agent, including all relevant HTTP(s) methods, URL patterns and wildcards.
Before registering an AI Agent, you need to have a Payment Plan created.
Copy
Ask AI
// When you register an agent, you need to provide the endpoints that the agent exposes and are protected by the Payment Plan// You must specify the HTTP method and the URL pattern that the agent exposes// You can use wildcards (like :agentId in the example) to match any string// See more information about the wildcards supported here: https://github.com/pillarjs/path-to-regexpconst agentMetadata: AgentMetadata = { name: 'E2E Payments Agent', tags: ['test'], dateCreated: new Date(), description: 'Description for the E2E Payments Agent'}// You can use wildcards (like :agentId in the example) to match any string in your endpointsconst agentApi = { endpoints: [ { 'POST': 'https://example.com/api/v1/agents/:agentId/tasks' }, { 'GET': 'https://example.com/api/v1/agents/:agentId/tasks/invoke' } ], openEndpoints: ['https://example.com/api/v1/rest/docs-json']}const paymentPlans = [creditsPlanId, expirablePlanId]const { agentId } = await payments.agents.registerAgent( agentMetadata, agentApi, paymentPlans)