Piriod is a billing, payments, procurement and collections platform. The API exposes the same building blocks our dashboard uses, so you can issue invoices, charge cards, manage subscriptions and reconcile payments programmatically.Documentation Index
Fetch the complete documentation index at: https://piriod-d406ac55.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Base URL
Required headers on every request
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Token <api_token>. See Authentication. |
x-simple-workspace | Yes | The workspace (account) identifier you are operating on. |
x-piriod-test-mode | No | true to use test-mode data. Defaults to false. |
Hello world
What’s next
- Integration flows walks you through end-to-end scenarios.
- Authentication explains tokens and workspaces.
- Error handling covers the response shape on failures.
- The API Reference tab lists every endpoint grouped by section.