canonical: https://jentic.com/apis/piriod.com/piriod # Piriod API Piriod API for period/subscription management and billing. The API exposes 10 endpoints. ## For AI agents Programmatically create subscription, list subscriptions. Covers 10 operations. ## Scope Does not handle communications, crm, or developer tools - use for payments only. ## Capabilities - Create subscription - List subscriptions - Get subscription - Update subscription - Cancel subscription ## Use cases ### Payments Operations Use the Piriod API to perform payments operations programmatically. The API provides 10 endpoints covering core functionality including create subscription, list subscriptions, get subscription. Example prompt: Call POST /subscriptions to create subscription ### Automated Customers Management Automate customers operations by combining multiple Piriod API endpoints. Agents can list subscriptions and then get subscription in a single workflow. Example prompt: Call GET /subscriptions to list subscriptions, then verify the result ### AI Agent Integration via Jentic AI agents discover and call Piriod API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually. Example prompt: Search Jentic for 'create subscription', load the operation schema, and execute with Jentic-managed credentials ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/subscriptions` | Create subscription | | GET | `/subscriptions` | List subscriptions | | GET | `/subscriptions/{id}` | Get subscription | | PUT | `/subscriptions/{id}` | Update subscription | | DELETE | `/subscriptions/{id}` | Cancel subscription | | POST | `/customers` | Create customer | | GET | `/customers` | List customers | | GET | `/customers/{id}` | Get customer | ## Key resources - **Customers** — Operations related to Customers - **Invoices** — Operations related to Invoices - **Subscriptions** — Operations related to Subscriptions ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 71 / 100 - **Maturity:** AI-Aware - **Dimensions:** - Foundational Compliance: 62 / 100 - Developer Experience & Jentic Compatibility: 61 / 100 - AI-Readiness & Agent Experience: 56 / 100 - Agent Usability: 94 / 100 - Security: 100 / 100 - AI Discoverability: 100 / 100 - **View full report:** https://jentic.com/apis/piriod.com/piriod/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring Piriod by hand means managing its request format, coordinating subscription and customer calls, and handling retries yourself. Through Jentic you install once, import Piriod from the API Directory, store the credential once, and your agent calls it. - **Permission scoping:** You limit the agent to the operations it needs, such as creating a subscription or reading a customer. Because you choose the allowed operations, deleting a subscription stays out of scope unless you add it. - **Credential handling:** Your Piriod credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'create a subscription' or 'look up a customer', and Jentic returns the matching Piriod operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Stripe** — Alternative payments API - **Adyen** — Alternative payments API - **Square** — Complementary payments API - **Paypal** — Complementary payments API ## FAQ ### What authentication does the Piriod API use? The Piriod API uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context. ### Can I create subscription with the Piriod API? Yes. Use the POST /subscriptions endpoint. The API returns structured JSON responses that agents can parse and act on directly. ### What are the rate limits for the Piriod API? Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer. ### How do I create subscription through Jentic? Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create subscription'. Jentic returns the matching Piriod API operation with its input schema. Load the schema and execute the call - credentials are injected automatically. ### How many endpoints does the Piriod API have? The Piriod API exposes 10 endpoints covering customers, invoices, subscriptions operations. ### Can I limit what my agent is allowed to do with the Piriod API? Yes. Because Jentic One is self-hosted, you set the rules that decide which Piriod operations and credentials your agent may use. You can allow only the calls the agent needs, such as creating a subscription or reading a customer, while keeping destructive calls like canceling a subscription out of scope unless you explicitly add them. The stored credential is injected at execution time, so the agent acts only within the operations you permit.