> For the complete documentation index, see [llms.txt](https://docs.perkville.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.perkville.com/integrations/integration-reference/stripe.md).

# Stripe

Attain credentials for your Stripe-Perkville integration

Use Stripe customer, invoice and subscription data in your Perkville program.

## Integration at a glance <a href="#capabilities-and-use-cases" id="capabilities-and-use-cases"></a>

* **Purchases** — Reward qualifying purchase activity and handle refunds.
* **Subscriptions** — Use subscriptions for eligibility and external membership data; support configured new-member challenges.
* **Coupons** — Stripe offers promotion codes; confirm the intended reward setup rather than assuming the connection creates them.

### Membership tier rewards

Offer points, instant rewards, or both for qualifying active membership tiers, including when members join at a higher tier or upgrade. Each tier is earned once. See [Membership tiers](https://docs.perkville.com/features/earning-rules/membership-tiers.md) for setup.

Requires the subscription-data workflow, which sends a membership type from an active subscription's description and a mapped status. A customer-only sync is insufficient; confirm the type when multiple subscriptions exist. Memberships and tier rewards must be enabled in Perkville, with the qualifying membership types and active statuses syncing from your system.

Your configured rules determine which eligible activities award points and which workflows are enabled.

{% stepper %}
{% step %}

### Attain a Stripe API key

Follow the instruction linked below on Stripe's website to create a secret API key. You will want to name your key to indicate that it's being used for Perkville. You can enter info.perkville.com as the 3rd party URL.

{% embed url="<https://docs.stripe.com/keys#secret-and-restricted-keys>" %}

{% hint style="info" %}
If you want to use [a secret key](https://docs.stripe.com/keys#create-restricted-api-secret-key), consult with your Perkville representative to find out which resources Perkville needs access to
{% endhint %}
{% endstep %}

{% step %}

### Provide the key to Perkville

Provide the key to your Perkville representative via a secure method, like [OneTimeSecret](https://onetimesecret.com/).

{% hint style="info" %}
If you're like to enter the credentials yourself, consult with your Perkville representative. We can give you access to an account in our integration layer, [Middle](https://middle.app), to enter the credential yourself.
{% endhint %}
{% endstep %}
{% endstepper %}

## FAQ

### Can subscriptions affect who earns?

Yes. Subscription data can be used for eligibility; confirm which subscriptions and statuses should qualify.

See the [Stripe partner profile](https://partners.perkville.com/partners/stripe) for additional integration information.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.perkville.com/integrations/integration-reference/stripe.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
