# Stream App API Documentation

> Complete API documentation and guides for Stream App

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [Getting Started with Stream](https://docs.streampay.sa/docs/guides/GETTING_STARTED.md): import FrontendUrl from '@site/src/components/FrontendUrl';
- [Pagination & Filtering](https://docs.streampay.sa/docs/guides/pagination-and-filtering.md): Pagination helps you efficiently navigate, sort, and filter large collections of data without fetching everything at once.
- [Webhooks](https://docs.streampay.sa/docs/guides/webhooks.md): import FrontendUrl from '@site/src/components/FrontendUrl';
- [Testing Cards](https://docs.streampay.sa/docs/guides/testing-cards.md): In order to test your application without having to go live with cards and accounts, you can use [Moyasar's testing cards](https://docs.moyasar.com...
- [Installments](https:/docs.streampay.sa//docs/guides/installments.md): import FrontendUrl from '@site/src/components/FrontendUrl';
- [Authentication](https://docs.streampay.sa/docs/guides/authentication.md): import FrontendUrl from '@site/src/components/FrontendUrl';
- [Branches in the API](https://docs.streampay.sa/docs/guides/branches.md): API requests are always scoped to a single branch. When creating an API key, you specify which branches it can access. For each request, you can se...
- [Embedded Checkout](https://docs.streampay.sa/docs/guides/embedded-checkout.md): Render a payment link checkout in-page with the Stream Embed SDK. Create a payment link via the API first, then pass the response **`url`** into `p...
- [Stream API Errors](https://docs.streampay.sa/docs/guides/errors.md): This page documents the error response format and the standardized error codes returned by Stream API endpoints. The goal is to provide a stable, p...
- [Handling Your Own Notifications](https://docs.streampay.sa/docs/guides/handling-your-own-notifications.md): import FrontendUrl from '@site/src/components/FrontendUrl';
- [Stream MCP Server](https://docs.streampay.sa/docs/guides/mcp-server.md): MCP (Model Context Protocol) is a standard way for AI clients to call tools and read resources from external systems.
- [Auto Charge On Demand](https://docs.streampay.sa/docs/api/v2-payments-auto-charge-on-demand.md): Charge a payment using the consumer's latest tokenized card.
- [Cancel Scheduled Subscription Plan Change](https://docs.streampay.sa/docs/api/v2-subscriptions-pending-change-cancel.md): Cancel a previously-scheduled deferred plan change.
- [Cancel Subscription](https://docs.streampay.sa/docs/api/v2-subscriptions-cancel.md): Schedule or complete cancellation and optionally cancel related invoices.
- [Create Branch](https://docs.streampay.sa/docs/api/v2-branches-create.md): Create a new branch for the organization.
- [Create Consumer](https://docs.streampay.sa/docs/api/v2-consumers-create.md): Create a new consumer with contact information and payment details.
- [Create Coupon](https://docs.streampay.sa/docs/api/v2-coupons-create.md): Create a new coupon with discount details and active/inactive status.
- [Create Invite For A User To Join The Organization By Email](https://docs.streampay.sa/docs/api/v2-organization-invite-create.md): Send an email invitation for a user to join the organization.
- [Create Invoice](https://docs.streampay.sa/docs/api/v2-invoices-create.md): Create a new invoice with items and payment details.
- [Create Payment Link](https://docs.streampay.sa/docs/api/v2-payment-links-create.md): Create a new checkout/payment link for collecting payments.
- [Create Product](https://docs.streampay.sa/docs/api/v2-products-create.md): Create a new product with pricing and description.
- [Create Subscription](https://docs.streampay.sa/docs/api/v2-subscriptions-create.md): Create a new subscription with items, coupons, and payment methods.
- [Delete Branch](https://docs.streampay.sa/docs/api/v2-branches-delete.md): Delete a branch from the organization.
- [Delete Consumer](https://docs.streampay.sa/docs/api/v2-consumers-delete.md): Delete a consumer from the organization.
- [Delete Coupon](https://docs.streampay.sa/docs/api/v2-coupons-delete.md): Delete a coupon from the organization.
- [Delete Product](https://docs.streampay.sa/docs/api/v2-products-delete.md): Delete a product from the organization.
- [Delete Subscription Freeze](https://docs.streampay.sa/docs/api/v2-subscriptions-unfreeze.md): Remove a freeze period from a subscription.
- [Freeze Subscription](https://docs.streampay.sa/docs/api/v2-subscriptions-freeze.md): Freeze a subscription to pause invoice generation for a specific period.
- [Get All Branches](https://docs.streampay.sa/docs/api/v2-branches-list.md): List all branches for the organization.
- [Get All Consumers](https://docs.streampay.sa/docs/api/v2-consumers-list.md): List all consumers with pagination, filtering, and sorting options.
- [Get Branch By Id](https://docs.streampay.sa/docs/api/v2-branches-get.md): Retrieve detailed information about a specific branch by its ID.
- [Get Consumer](https://docs.streampay.sa/docs/api/v2-consumers-get.md): Retrieve detailed information about a specific consumer by their ID.
- [Get Coupon](https://docs.streampay.sa/docs/api/v2-coupons-get.md): Retrieve detailed information about a specific coupon including redemption history.
- [Get Invoice](https://docs.streampay.sa/docs/api/v2-invoices-get.md): Retrieve detailed information about a specific invoice by its ID.
- [Get Payment](https://docs.streampay.sa/docs/api/v2-payments-get.md): Retrieve detailed information about a specific payment by its ID.
- [Get Payment Link](https://docs.streampay.sa/docs/api/v2-payment-links-get.md): Retrieve detailed information about a specific payment link by its ID.
- [Get Product](https://docs.streampay.sa/docs/api/v2-products-get.md): Retrieve detailed information about a specific product by its ID.
- [Get Subscription](https://docs.streampay.sa/docs/api/v2-subscriptions-get.md): Retrieve detailed information about a specific subscription by its ID.
- [Get User And Organization Info](https://docs.streampay.sa/docs/api/v2-me-get.md): Retrieve information about the authenticated user and their organization.
- [List Coupons](https://docs.streampay.sa/docs/api/v2-coupons-list.md): List all coupons with pagination, filtering, and sorting options.
- [List Invoices](https://docs.streampay.sa/docs/api/v2-invoices-list.md): List all invoices with pagination, filtering, and sorting options.
- [List Payment Links](https://docs.streampay.sa/docs/api/v2-payment-links-list.md): List all payment links with pagination, filtering, and sorting options.
- [List Payments](https://docs.streampay.sa/docs/api/v2-payments-list.md): List all payments with pagination, filtering, and sorting options.
- [List Products](https://docs.streampay.sa/docs/api/v2-products-list.md): List all products with pagination, filtering, and sorting options.
- [List Subscription Freezes](https://docs.streampay.sa/docs/api/v2-subscriptions-freezes-list.md): List all freeze periods for a specific subscription.
- [List Subscriptions](https://docs.streampay.sa/docs/api/v2-subscriptions-list.md): List all subscriptions with pagination, filtering, and sorting options.
- [Mark Payment As Paid](https://docs.streampay.sa/docs/api/v2-payments-mark-paid.md): Manually mark a payment as paid.
- [Refund Payment](https://docs.streampay.sa/docs/api/v2-payments-refund.md): Process a refund for a payment.
- [Uncancel Subscription](https://docs.streampay.sa/docs/api/v2-subscriptions-uncancel.md): Withdraw a pending cancellation so the subscription continues after the current billing period.
- [Update Branch](https://docs.streampay.sa/docs/api/v2-branches-update.md): Update branch information.
- [Update Consumer](https://docs.streampay.sa/docs/api/v2-consumers-update.md): Update consumer information such as contact details or payment methods.
- [Update Coupon](https://docs.streampay.sa/docs/api/v2-coupons-update.md): Update coupon details such as discount amount or active status.
- [Update Invoice In Place](https://docs.streampay.sa/docs/api/v2-invoices-update-in-place.md): Partially update specific invoice fields in-place.
- [Update Payment Link Coupons](https://docs.streampay.sa/docs/api/v2-payment-links-update-coupons.md): Update link-level and item-level coupons on a payment link.
- [Update Payment Link Status](https://docs.streampay.sa/docs/api/v2-payment-links-update-status.md): Update the status of a payment link.
- [Update Product](https://docs.streampay.sa/docs/api/v2-products-update.md): Update product details such as name, price, or description.
- [Update Subscription](https://docs.streampay.sa/docs/api/v2-subscriptions-update.md): Update subscription items, coupons, billing interval, description, auto-cancel cycles, or payment methods.
- [Update Subscription Freeze](https://docs.streampay.sa/docs/api/v2-subscriptions-freeze-update.md): Update an existing subscription freeze period.
- [Express SDK](https://docs.streampay.sa/sdks/express.md): For the complete Express SDK documentation, please visit our GitHub repository:
- [TypeScript SDK](https://docs.streampay.sa/sdks/typescript.md): For the complete TypeScript SDK documentation, please visit our GitHub repository: