> ## Documentation Index
> Fetch the complete documentation index at: https://docs.piriod.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Welcome to the Piriod API.

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

<CodeGroup>
  ```text Production theme={null}
  https://api.piriod.com
  ```

  ```text Development theme={null}
  https://api.dev.piriod.com
  ```
</CodeGroup>

## Required headers on every request

| Header               | Required | Description                                                 |
| -------------------- | -------- | ----------------------------------------------------------- |
| `Authorization`      | Yes      | `Token <api_token>`. See [Authentication](/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

```bash theme={null}
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](/pagination-filtering).

## What's next

* [Integration flows](/integration-flows) walks you through end-to-end scenarios.
* [Authentication](/authentication) explains tokens and workspaces.
* [Error handling](/error-handling) covers the response shape on failures.
* The **API Reference** tab lists every endpoint grouped by section.