Stream

Create a new payment / checkout link on Stream.

items is a list of objects, each containing:

• product_id (str, required)

• quantity (int ≥ 1, optional, default 1)

• coupons (list[str], optional)

You cannot mix one-time and recurring products in the same link.

List all payment links with optional filters.

statuses can include: INACTIVE, ACTIVE, COMPLETED.

Retrieve a single payment link by its ID.

Deactivate (archive) a payment link so it can no longer be used.

Create a new customer in Stream.

Provide at least a name. Optionally include phone_number, email, external_id, iban, alias, comment, preferred_language (EN/AR), and communication_methods (WHATSAPP, EMAIL, SMS).

List / search customers with pagination.

Returns a paginated list of customers.

Get a single customer record by ID.

Update fields on an existing customer.

Only the fields you provide will be changed; others remain untouched.

Soft-delete a customer by ID.

The customer record is archived but not permanently removed.

Create a new product or service in Stream.

type is ONE_OFF, RECURRING, or METERED. For recurring products, specify recurring_interval (WEEK, MONTH, SEMESTER, YEAR).

List products with optional filters.

type can be ONE_OFF, RECURRING, or METERED. active filters by active/inactive status.

Get a single product by ID.

Update an existing product's name, description, or active status.

Only the fields you provide will be changed.

Archive a product so it can no longer be sold.

This is a soft-delete; the product record is retained for history.

List payments with optional filters.

Filter by statuses (PENDING, PROCESSING, SUCCEEDED, FAILED, CANCELED, UNDER_REVIEW, EXPIRED, SETTLED, REFUNDED), invoice_id, search_term, or a date range (from_date / to_date in ISO-8601).

Get details of a single payment by ID.

Returns amount, status, payment method, customer info, and more.

Manually mark a payment as paid.

Record a payment received through manual methods. payment_method must be one of: CASH, BANK_TRANSFER, CARD, or QURRAH.

Issue a refund on a completed payment.

refund_reason must be one of: REQUESTED_BY_CUSTOMER, DUPLICATE, FRAUDULENT, OTHER.

Create a new discount coupon on Stream.

Set is_percentage to True for percentage discount, False for fixed amount. For fixed coupons, currency is required (e.g. SAR, USD).

List all coupons with optional filters.

active filters by active/inactive status. is_percentage filters by discount type.

Get a single coupon by ID.

Deactivate a coupon so it can no longer be redeemed.

Create a ZATCA-compliant invoice in Stream.

items is a list of line-item dicts, each with:

• product_id (str, required)

• quantity (int > 0, required)

scheduled_on is the ISO-8601 date-time for when the invoice is due/sent. Set notify_consumer to True to send the invoice to the customer.

List invoices with optional filters.

Filter by organization_consumer_id, statuses (DRAFT, CREATED, SENT, ACCEPTED, REJECTED, COMPLETED, CANCELED, EXPIRED), payment_statuses (PENDING, PROCESSING, SUCCEEDED, FAILED, etc.), or a date range.

Get a single invoice by ID.

(Re)send an invoice to the customer via email / SMS.

Void (cancel) an unpaid invoice.

Once voided, the invoice can no longer be paid.

List all available Stream documentation pages.

Pages are auto-discovered from the Stream docs sitemap. Returns slug, URL, and resource URI for each page. Use the slug with get_stream_doc to fetch the full content.

Fetch the content of a Stream documentation page by slug.

Slugs are auto-discovered from the sitemap. Call list_stream_docs first to see what's available, or pass a slug directly if you already know it (e.g. 'getting-started', 'testing-cards', 'webhooks', 'authentication', etc.).