Introduction - Piriod Docs

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.

Base URL

https://api.piriod.com

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

curl https://api.piriod.com/customers/ \
  -H "Authorization: Token sk_live_xxxxx" \
  -H "x-simple-workspace: acc_01H8XYZ123ABC"

The response is a paginated list of customers; see Pagination and filtering.

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.

​Base URL

​Required headers on every request

​Hello world

​What’s next

Base URL

Required headers on every request

Hello world

What’s next