> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/references/v1/resources/nilus/roles-and-permissions/stripe-minimum-permissions.md).

# Stripe

This page documents the minimum Stripe API key permissions a platform administrator must provision for Nilus to run batch pipelines against a Stripe account. Stripe is supported as a **batch read source only**.

## Pipeline modes supported

| Mode        | Supported |
| ----------- | --------- |
| Batch read  | Yes       |
| Batch write | No        |
| CDC         | No        |
| Metadata    | No        |

## Read data: Stripe as source (`type: batch`)

Nilus uses this path when the depot is referenced in `source.address` of a pipeline config. Nilus queries the Stripe API for each configured resource category.

### Minimum API key requirement

Use a **Restricted Key** scoped to only the resource categories being ingested. Do not use a full secret key in production.

{% hint style="warning" %}
A full secret key grants read and write access to every resource in the Stripe account. Always scope the pipeline's key to a Restricted Key with Read-only access on the ingested resource categories.
{% endhint %}

To create a Restricted Key:

1. Stripe Dashboard → Developers → API keys → **Create restricted key**
2. Enable **Read** only on the resource categories the pipeline ingests
3. Click **Create key** and store it securely

### Minimum grants

| Permission                                | Why required                                                                          |
| ----------------------------------------- | ------------------------------------------------------------------------------------- |
| `Read` on each required resource category | Nilus queries Stripe APIs to pull records; without read access, the API returns `403` |

## Permission matrix

| Use case             | Restricted Key: Read on ingested resources |
| -------------------- | ------------------------------------------ |
| Read (source, batch) | Yes                                        |

## Notes

* Stripe is supported as a batch read source only. No write, CDC, or metadata pipeline mode exists for Stripe depots.
* Scope the Restricted Key narrowly: enable Read only on the specific resource categories the pipeline ingests, not on the entire account.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://v2.dataos.info/references/v1/resources/nilus/roles-and-permissions/stripe-minimum-permissions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.