# Reditus docs

## Docs

- [Authentication](https://docs.getreditus.com/affiliate-program-api/authentication.md): Affiliate Program API - Authentication
- [Introduction](https://docs.getreditus.com/affiliate-program-api/introduction.md): This is the public API documentation for Reditus Affiliate Programs
- [Rate Limits](https://docs.getreditus.com/affiliate-program-api/rate-limits.md): Affiliate Program API Rate Limits
- [List affiliates](https://docs.getreditus.com/affiliate-program-api/v1/partners/index.md): Retrieve a paginated list of partners.
- [Show affiliate](https://docs.getreditus.com/affiliate-program-api/v1/partners/show.md): Show data for a partner
- [List Partnerships](https://docs.getreditus.com/affiliate-program-api/v1/partnerships/index.md): Retrieve a paginated list of partnerships.
- [Show Partnership](https://docs.getreditus.com/affiliate-program-api/v1/partnerships/show.md): Show data for a partnership.
- [Create Payment](https://docs.getreditus.com/affiliate-program-api/v1/payments/create.md): The payments API allows you to add payments for your referrals/leads. If you want to track a one-off payment, just don't specify `subscription_id`, `interval` and `interval_count`.
- [Show Payment](https://docs.getreditus.com/affiliate-program-api/v1/payments/show.md): Show data for a payment.
- [List Referrals](https://docs.getreditus.com/affiliate-program-api/v1/referrals/index.md): Retrieve a paginated list of referrals
- [Show Referral](https://docs.getreditus.com/affiliate-program-api/v1/referrals/show.md): Show data for a referral.
- [Create Refund](https://docs.getreditus.com/affiliate-program-api/v1/refunds/create.md): Marks a commission as rejected based on a refunded payment. Requires a valid `payment_id`.
- [Delete Subscription](https://docs.getreditus.com/affiliate-program-api/v1/subscriptions/destroy.md): Cancels a subscription.
- [Show Subscription](https://docs.getreditus.com/affiliate-program-api/v1/subscriptions/show.md): Show data for a subscription
- [Track Conversion (Deprecating) - Use V2 Instead](https://docs.getreditus.com/affiliate-program-api/v1/tracking/conversion.md): The tracking API allows you to track conversions for any affiliate.
- [Track Conversion](https://docs.getreditus.com/affiliate-program-api/v2/tracking/conversion.md): The tracking API allows you to track conversions for any affiliate.
- [Get Started](https://docs.getreditus.com/affiliate-program/get_started.md): Get Started with the Reditus affiliate program
- [Advanced Installation](https://docs.getreditus.com/affiliate-program/signup-snippet/advanced_installation.md): Signup Snippet Advanced Installation
- [Installation](https://docs.getreditus.com/affiliate-program/signup-snippet/installation.md): Signup Snippet Installation
- [Introduction](https://docs.getreditus.com/affiliate-program/signup-snippet/introduction.md): Signup Snippet Introduction
- [Excluding plans & prices](https://docs.getreditus.com/affiliate-program/stripe/excluding_plans.md): Exclude certain plans from generating commissions
- [FAQs](https://docs.getreditus.com/affiliate-program/tracking-script/faq.md): Frequently asked questions
- [Installation](https://docs.getreditus.com/affiliate-program/tracking-script/installation.md): Tracking Script Installation
- [Introduction](https://docs.getreditus.com/affiliate-program/tracking-script/introduction.md): Tracking Script Introduction
- [Authentication](https://docs.getreditus.com/affiliates-api/authentication.md): Affiliates API - Authentication
- [Introduction](https://docs.getreditus.com/affiliates-api/introduction.md): This is the public API documentation for Reditus Affiliates
- [Rate Limits](https://docs.getreditus.com/affiliates-api/rate-limits.md): Affiliates API Rate Limits
- [List Commissions](https://docs.getreditus.com/affiliates-api/v1/affiliate_commissions/index.md): Retrieve a paginated list of commissions. This is an endpoint from the Affiliates API. You will need an affiliate account and its token in order to use this endpoint.
- [List Referrals](https://docs.getreditus.com/affiliates-api/v1/affiliate_referrals/index.md): Retrieve a paginated list of referrals. This is an endpoint from the Affiliates API. You will need an affiliate account and its token in order to use this endpoint.
- [List Sub IDs](https://docs.getreditus.com/affiliates-api/v1/affiliate_sub_ids/index.md): Retrieve a list of Sub IDs. This is an endpoint from the Affiliates API. You will need an affiliate account and its token in order to use this endpoint. Sub IDs are present in the affiliate links via the 'sid' query params.
- [Platform overview](https://docs.getreditus.com/get-started/introduction.md): The resources you need to get started with Reditus
- [Authentication](https://docs.getreditus.com/referral-program-api/authentication.md): Referral Program API - Authentication
- [Introduction](https://docs.getreditus.com/referral-program-api/introduction.md): This is the public API documentation for Reditus Referral Programs
- [Rate Limits](https://docs.getreditus.com/referral-program-api/rate-limits.md): Referral Program API Rate Limits
- [Create Advocate](https://docs.getreditus.com/referral-program-api/v1/advocates/create.md): Create an advocate for your referral program
- [Set Payment Method](https://docs.getreditus.com/referral-program-api/v1/advocates/create_payment_method.md): Set or update the payment method for an advocate. The advocate can be looked up by their Reditus ID (UUID) or by their uid (your internal user ID). When switching payment types, the previous payment data is automatically cleared. Use this endpoint to store sensitive payment information (IBAN, PayPal…
- [List Advocates](https://docs.getreditus.com/referral-program-api/v1/advocates/index.md): Retrieve a paginated list of advocates
- [Show Advocate](https://docs.getreditus.com/referral-program-api/v1/advocates/show.md): Retrieve details of a specific advocate by their Reditus ID (UUID) or by their uid (your internal user ID).
- [Get Payment Method](https://docs.getreditus.com/referral-program-api/v1/advocates/show_payment_method.md): Retrieve the masked payment method for an advocate. The advocate can be looked up by their Reditus ID (UUID) or by their uid (your internal user ID). Returns anonymized payment details so you can show a "connected" state without exposing sensitive data.
- [List Leads](https://docs.getreditus.com/referral-program-api/v1/leads/index.md): Retrieve a paginated list of leads
- [Show Lead](https://docs.getreditus.com/referral-program-api/v1/leads/show.md): Show data for a lead.
- [Create Payment](https://docs.getreditus.com/referral-program-api/v1/payments/create.md): The payments API allows you to add payments for your referrals/leads. If you want to track a one-off payment, just don't specify `subscription_id`, `interval` and `interval_count`.
- [Create Refund](https://docs.getreditus.com/referral-program-api/v1/refunds/create.md): Marks a commission as rejected based on a refunded payment. Requires a valid `payment_id`.
- [List Reward Triggers](https://docs.getreditus.com/referral-program-api/v1/reward_triggers/index.md): Retrieve a paginated list of reward triggers configured for your referral program. Reward triggers define the conditions and amounts for rewarding advocates.
- [List Rewards](https://docs.getreditus.com/referral-program-api/v1/rewards/index.md): Retrieve a paginated list of rewards
- [Update Reward](https://docs.getreditus.com/referral-program-api/v1/rewards/update.md): Set the reward's state to 'paid'
- [Track Conversion](https://docs.getreditus.com/referral-program-api/v2/tracking/conversion.md): The tracking API allows you to track conversions for any affiliate.
- [Authenticating the User](https://docs.getreditus.com/referral-program/authentication.md): Generate a JSON Web Token (JWT) to securely associate referral data with individual users.
- [Get Started](https://docs.getreditus.com/referral-program/get_started.md): Get Started with the Reditus referral program
- [Loading the Widget](https://docs.getreditus.com/referral-program/loading.md): Learn how to load the Reditus referral program widget into your application.
- [Referral Rewards](https://docs.getreditus.com/referral-program/referral_rewards.md): Give rewards to the users advocates bring in
- [Showing the Widget Modal](https://docs.getreditus.com/referral-program/show.md): Display the in-app referral modal so users can share referral links and track referrals directly in your application.
- [Excluding plans & prices](https://docs.getreditus.com/referral-program/stripe/excluding_plans.md): Exclude certain plans from generating rewards
- [partnership.accepted](https://docs.getreditus.com/webhooks/affiliate-program/partnership_accepted.md): Partnership - partnership.accepted
- [referral.created](https://docs.getreditus.com/webhooks/affiliate-program/referrals_created.md): Referrals - referral.created
- [Get Started](https://docs.getreditus.com/webhooks/get_started.md): Send events from Reditus to webhook endpoints
- [advocate.created](https://docs.getreditus.com/webhooks/referral-program/advocate_created.md): Advocates - advocate.created
- [lead.created](https://docs.getreditus.com/webhooks/referral-program/lead_created.md): Leads - lead.created
- [reward.created](https://docs.getreditus.com/webhooks/referral-program/reward_created.md): Rewards - reward.created

## OpenAPI Specs

- [advocate_payment_methods](https://docs.getreditus.com/referral-program-api/v1/advocate_payment_methods.json)
- [rewards](https://docs.getreditus.com/referral-program-api/v1/rewards.json)
- [advocates](https://docs.getreditus.com/referral-program-api/v1/advocates.json)
- [reward_triggers](https://docs.getreditus.com/referral-program-api/v1/reward_triggers.json)
- [tracking](https://docs.getreditus.com/affiliate-program-api/v2/tracking.json)
- [partnerships](https://docs.getreditus.com/affiliate-program-api/v1/partnerships.json)
- [partners](https://docs.getreditus.com/affiliate-program-api/v1/partners.json)
- [refunds](https://docs.getreditus.com/referral-program-api/v1/refunds.json)
- [affiliate_sub_ids](https://docs.getreditus.com/affiliates-api/v1/affiliate_sub_ids.json)
- [subscriptions](https://docs.getreditus.com/affiliate-program-api/v1/subscriptions.json)
- [payments](https://docs.getreditus.com/affiliate-program-api/v1/payments.json)
- [affiliate_commissions](https://docs.getreditus.com/affiliates-api/v1/affiliate_commissions.json)
- [affiliate_referrals](https://docs.getreditus.com/affiliates-api/v1/affiliate_referrals.json)
- [leads](https://docs.getreditus.com/referral-program-api/v1/leads.json)
- [referrals](https://docs.getreditus.com/affiliate-program-api/v1/referrals.json)

## Optional

- [Help Center](https://help.getreditus.com)