> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.prolifi.io/api-reference/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.prolifi.io/_mcp/server.

# API Reference

## Docs

- [Authentication](https://docs.prolifi.io/api-guides/authentication.md): How to authenticate requests to the Prolifi Public API
- [Errors](https://docs.prolifi.io/api-guides/errors.md): Error types, response format, and handling guidance
- [Pagination](https://docs.prolifi.io/api-guides/pagination.md): How to paginate through list endpoints
- [Rate Limiting](https://docs.prolifi.io/api-guides/rate-limiting.md): Request limits, headers, and handling guidance
- [Idempotency](https://docs.prolifi.io/api-guides/idempotency.md): Safely retry requests without duplicating operations
- [IP Whitelisting](https://docs.prolifi.io/api-guides/ip-whitelisting.md): Restrict API access to specific IP addresses
- [Plans](https://docs.prolifi.io/api-reference.md): Browse the product catalog
- [Customers](https://docs.prolifi.io/endpoints/customers.md): Create and manage customer records
- [Subscriptions](https://docs.prolifi.io/endpoints/subscriptions.md): Create and manage subscriptions
- [Invoices](https://docs.prolifi.io/endpoints/invoices.md): List, retrieve, finalize, and void invoices
- [Usage Events](https://docs.prolifi.io/endpoints/usage-events.md): Report metered usage for usage-based billing
- [Entitlements](https://docs.prolifi.io/endpoints/entitlements.md): Check feature access and retrieve entitlement balances

## API Docs

- API Reference > Plans [List plans](https://docs.prolifi.io/endpoints/plans/list-plans.md)
- API Reference > Plans [Get a plan](https://docs.prolifi.io/endpoints/plans/get-plan.md)
- API Reference > Customers [Create a customer](https://docs.prolifi.io/endpoints/customers/create-customer.md)
- API Reference > Customers [List customers](https://docs.prolifi.io/endpoints/customers/list-customers.md)
- API Reference > Customers [Get a customer](https://docs.prolifi.io/endpoints/customers/get-customer.md)
- API Reference > Customers [Update a customer](https://docs.prolifi.io/endpoints/customers/update-customer.md)
- API Reference > Customers [Delete a customer](https://docs.prolifi.io/endpoints/customers/delete-customer.md)
- API Reference > Subscriptions [Create a subscription](https://docs.prolifi.io/endpoints/subscriptions/create-subscription.md)
- API Reference > Subscriptions [List subscriptions](https://docs.prolifi.io/endpoints/subscriptions/list-subscriptions.md)
- API Reference > Subscriptions [Get a subscription](https://docs.prolifi.io/endpoints/subscriptions/get-subscription.md)
- API Reference > Subscriptions [Update a subscription](https://docs.prolifi.io/endpoints/subscriptions/update-subscription.md)
- API Reference > Subscriptions [Cancel a subscription](https://docs.prolifi.io/endpoints/subscriptions/cancel-subscription.md)
- API Reference > Subscriptions [Pause a subscription](https://docs.prolifi.io/endpoints/subscriptions/pause-subscription.md)
- API Reference > Subscriptions [Resume a subscription](https://docs.prolifi.io/endpoints/subscriptions/resume-subscription.md)
- API Reference > Invoices [List invoices](https://docs.prolifi.io/endpoints/invoices/list-invoices.md)
- API Reference > Invoices [Get an invoice](https://docs.prolifi.io/endpoints/invoices/get-invoice.md)
- API Reference > Invoices [Finalize an invoice](https://docs.prolifi.io/endpoints/invoices/finalize-invoice.md)
- API Reference > Invoices [Void an invoice](https://docs.prolifi.io/endpoints/invoices/void-invoice.md)
- API Reference > Usage Events [Report a usage event](https://docs.prolifi.io/endpoints/usage-events/report-usage-event.md)
- API Reference > Usage Events [Batch report usage events](https://docs.prolifi.io/endpoints/usage-events/batch-report-usage-events.md)
- API Reference > Usage Events [Get customer usage summary](https://docs.prolifi.io/endpoints/usage-events/get-customer-usage.md)
- API Reference > Entitlements [Check entitlement](https://docs.prolifi.io/endpoints/entitlements/check-entitlement.md)
- API Reference > Entitlements [Get customer entitlements](https://docs.prolifi.io/endpoints/entitlements/get-customer-entitlements.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.prolifi.io/api-reference/openapi.json)
- [OpenAPI YAML](https://docs.prolifi.io/api-reference/openapi.yaml)


> **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.prolifi.io/api-reference/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.prolifi.io/_mcp/server.

# API Reference

The Prolifi Public API lets you integrate subscription billing, customer management, usage metering, and entitlement checks directly into your application.

## Base URL

```
https://api.prolifi.co/api/v1/public
```

## Quick start

1. Generate API keys from the Prolifi dashboard (**Settings > API Keys**)
2. Use your secret key (`sk_test_*`) for server-side integrations
3. Make your first request:

```bash
curl https://api.prolifi.co/api/v1/public/plans \
  -H "Authorization: Bearer sk_test_your_key_here"
```

## Resources

#### [Authentication](/api-guides/authentication)

API key types, environments, and security

#### [Errors](/api-guides/errors)

Error format, types, and handling guidance

#### [Pagination](/api-guides/pagination)

Offset-based pagination for list endpoints

#### [Rate Limiting](/api-guides/rate-limiting)

Request limits, headers, and retry strategies

#### [Idempotency](/api-guides/idempotency)

Safely retry requests without duplicating operations

#### [IP Whitelisting](/api-guides/ip-whitelisting)

Restrict API access to specific IP addresses

## API endpoints

The API is organized around six resource types:

| Resource          | Endpoints                                                                   | Description                            |
| ----------------- | --------------------------------------------------------------------------- | -------------------------------------- |
| **Plans**         | `GET /plans`, `GET /plans/{id}`                                             | Browse the product catalog (read-only) |
| **Customers**     | `POST`, `GET`, `PATCH`, `DELETE /customers`                                 | Manage customer records                |
| **Subscriptions** | `POST`, `GET`, `PATCH`, `DELETE /subscriptions`                             | Create and manage subscriptions        |
| **Invoices**      | `GET /invoices`, `POST /invoices/{id}/finalize`, `POST /invoices/{id}/void` | Invoice management                     |
| **Usage Events**  | `POST /events`, `POST /events/batch`, `GET /customers/{id}/usage`           | Usage-based billing                    |
| **Entitlements**  | `POST /entitlements/check`, `GET /customers/{id}/entitlements`              | Feature access and metering            |

Browse the full endpoint reference in the sidebar, or refer to the [Developers getting started guide](/getting-started/developers) for integration architecture and webhook events.