# RMZ Developer Docs

## Docs

- [Authentication](https://docs.rmz.gg/embed-api/authentication.md): OTP-based customer authentication flow for embed checkout.
- [Checkout](https://docs.rmz.gg/embed-api/checkout.md): Create checkout sessions and initiate payments via the Embed API.
- [Coupons](https://docs.rmz.gg/embed-api/coupons.md): Apply coupon codes and calculate discounts for embed checkout.
- [Embed API Overview](https://docs.rmz.gg/embed-api/overview.md): Embed a checkout widget for any RMZ product on external websites using the Embed API.
- [Payment Status](https://docs.rmz.gg/embed-api/payment-status.md): Check whether a payment has been completed for a checkout session.
- [Product Info](https://docs.rmz.gg/embed-api/product-info.md): Fetch product details for the embed checkout widget.
- [Configuration](https://docs.rmz.gg/fivem/configuration.md): All config.lua settings for the RMZ FiveM resource, including polling behavior and debug mode.
- [Installation](https://docs.rmz.gg/fivem/installation.md): Download, configure, and start the RMZ FiveM resource on your game server.
- [FiveM Integration Overview](https://docs.rmz.gg/fivem/overview.md): Automatically execute server commands when customers purchase products from your RMZ store. Deliver VIP, cash, vehicles, and more to players instantly.
- [Product Setup](https://docs.rmz.gg/fivem/product-setup.md): Create products with FiveM benefits, configure commands with variables, and set up revoke actions.
- [Troubleshooting](https://docs.rmz.gg/fivem/troubleshooting.md): Common errors, debug mode, and connection status indicators for the RMZ FiveM integration.
- [Authentication](https://docs.rmz.gg/getting-started/authentication.md): Understand how authentication works across all RMZ APIs.
- [Environments](https://docs.rmz.gg/getting-started/environments.md): Base URLs and environments for all RMZ APIs.
- [Error Handling](https://docs.rmz.gg/getting-started/error-handling.md): Understand error formats and HTTP status codes across RMZ APIs.
- [Introduction](https://docs.rmz.gg/getting-started/introduction.md): Learn about the RMZ platform and its developer ecosystem.
- [Quickstart](https://docs.rmz.gg/getting-started/quickstart.md): Make your first Merchant API call in under 5 minutes.
- [Rate Limiting](https://docs.rmz.gg/getting-started/rate-limiting.md): Understand rate limits across all RMZ APIs.
- [Building a Custom Storefront](https://docs.rmz.gg/guides/building-a-custom-storefront.md): End-to-end guide to building a headless storefront using the RMZ Storefront SDK and Next.js.
- [Embedding Checkout](https://docs.rmz.gg/guides/embedding-checkout.md): Add an RMZ product checkout widget to any external website.
- [License Integration](https://docs.rmz.gg/guides/license-integration.md): Add license key verification to your software using the RMZ licensing system.
- [Subscription Integration](https://docs.rmz.gg/guides/subscriptions.md): End-to-end guide to integrating RMZ subscriptions into your application, including storefront purchases, SaaS billing, webhooks, and the customer portal.
- [Webhook Integration](https://docs.rmz.gg/guides/webhook-integration.md): Set up and consume RMZ webhooks to react to store events in real time.
- [RMZ Developer Docs](https://docs.rmz.gg/index.md): Build on the leading digital products platform for the MENA region.
- [Activations](https://docs.rmz.gg/licensing/activations.md): How device activations work, max activation limits, and how to reset activations from the dashboard.
- [End-to-End Encryption (E2EE)](https://docs.rmz.gg/licensing/e2ee.md): Encrypt all license verification responses with AES-256-GCM to prevent man-in-the-middle attacks and proxy spoofing.
- [Error Codes](https://docs.rmz.gg/licensing/error-codes.md): All license verification error codes, HTTP status codes, and rate limiting behavior.
- [Node.js Examples](https://docs.rmz.gg/licensing/examples/javascript.md): Complete Node.js examples for license verification, with and without end-to-end encryption.
- [Lua / FiveM Examples](https://docs.rmz.gg/licensing/examples/lua-fivem.md): Complete FiveM Lua examples for license verification, with and without end-to-end encryption.
- [PHP Examples](https://docs.rmz.gg/licensing/examples/php.md): Complete PHP examples for license verification, with and without end-to-end encryption.
- [Python Examples](https://docs.rmz.gg/licensing/examples/python.md): Complete Python examples for license verification, with and without end-to-end encryption.
- [Lock Types](https://docs.rmz.gg/licensing/lock-types.md): Control how license keys are bound to devices. Choose between no binding, hardware ID locking, or IP address locking.
- [Licensing Overview](https://docs.rmz.gg/licensing/overview.md): Protect your software with license key verification. Customers purchase a key from your store and your software validates it with a single API call.
- [Plans & Duration](https://docs.rmz.gg/licensing/plans-and-duration.md): Duration-based pricing plans for license products, from monthly to decennial, plus lifetime licenses.
- [Verification Endpoint](https://docs.rmz.gg/licensing/verification.md): API reference for the license verification endpoint. Verify keys, auto-activate devices, and retrieve full license details in one call.
- [Categories](https://docs.rmz.gg/merchant-api/categories.md): Retrieve a paginated list of store categories.
- [Create Order](https://docs.rmz.gg/merchant-api/orders/create-order.md): Create a new order programmatically via the Merchant API.
- [Get Order](https://docs.rmz.gg/merchant-api/orders/get-order.md): Retrieve detailed information for a specific order.
- [List Orders](https://docs.rmz.gg/merchant-api/orders/list-orders.md): Retrieve a paginated list of orders with optional filters.
- [Update Order](https://docs.rmz.gg/merchant-api/orders/update-order.md): Update the status of an existing order.
- [Merchant API Overview](https://docs.rmz.gg/merchant-api/overview.md): Programmatically manage your RMZ store with the Merchant API.
- [Create Portal Session](https://docs.rmz.gg/merchant-api/portal-sessions/create-portal-session.md): Generate a customer billing portal session URL for subscription self-service.
- [Get Product](https://docs.rmz.gg/merchant-api/products/get-product.md): Retrieve detailed information for a specific product.
- [List Products](https://docs.rmz.gg/merchant-api/products/list-products.md): Retrieve a paginated list of products in your store.
- [Store](https://docs.rmz.gg/merchant-api/store.md): Retrieve store information and statistics.
- [Cancel Subscription](https://docs.rmz.gg/merchant-api/subscriptions/cancel-subscription.md): Cancel a customer subscription immediately or at the end of the current period.
- [Create Checkout Session](https://docs.rmz.gg/merchant-api/subscriptions/create-checkout-session.md): Create a checkout session for a customer to subscribe to a product.
- [Extend Subscription](https://docs.rmz.gg/merchant-api/subscriptions/extend-subscription.md): Extend a subscription's current period by a specified number of days or months.
- [Get Subscription](https://docs.rmz.gg/merchant-api/subscriptions/get-subscription.md): Retrieve detailed information for a specific subscription.
- [List Subscriptions](https://docs.rmz.gg/merchant-api/subscriptions/list-subscriptions.md): Retrieve a paginated list of customer subscriptions with optional filters.
- [Lookup Subscriptions](https://docs.rmz.gg/merchant-api/subscriptions/lookup-subscriptions.md): Check whether a user currently has an active subscription. Built for SaaS paywall integrations.
- [Pause Subscription](https://docs.rmz.gg/merchant-api/subscriptions/pause-subscription.md): Pause a customer subscription to temporarily suspend auto-renewal.
- [Unpause Subscription](https://docs.rmz.gg/merchant-api/subscriptions/unpause-subscription.md): Resume a paused subscription, restoring access and extending the billing period.
- [Analytics Collection](https://docs.rmz.gg/storefront-api/analytics.md): Collect pageview and custom analytics events from your storefront.
- [Customer Profile](https://docs.rmz.gg/storefront-api/authentication/customer-profile.md): Get and update authenticated customer profile information, and log out.
- [Guest Cart & Cart Tokens](https://docs.rmz.gg/storefront-api/authentication/guest-cart.md): How unauthenticated visitors can manage shopping carts using the X-Cart-Token header.
- [OTP Authentication Flow](https://docs.rmz.gg/storefront-api/authentication/otp-flow.md): Authenticate customers using OTP verification via phone number or email.
- [Coupons](https://docs.rmz.gg/storefront-api/cart/coupons.md): Apply and remove coupon codes from the shopping cart.
- [Manage Cart](https://docs.rmz.gg/storefront-api/cart/manage-cart.md): Add, update, remove, and validate cart items for guest and authenticated customers.
- [Categories](https://docs.rmz.gg/storefront-api/categories.md): Browse store categories and their products.
- [Checkout](https://docs.rmz.gg/storefront-api/checkout.md): Create checkout sessions and retrieve payment results.
- [Homepage Components](https://docs.rmz.gg/storefront-api/components.md): Retrieve configurable homepage components including banners, product lists, features, and reviews.
- [Courses](https://docs.rmz.gg/storefront-api/courses.md): Access enrolled courses, track progress, view module content, and mark modules as completed.
- [Custom Storefront Tokens](https://docs.rmz.gg/storefront-api/custom-tokens.md): Generate, manage, and validate API tokens for custom storefronts connecting to your store.
- [Management API](https://docs.rmz.gg/storefront-api/management.md): Server-to-server endpoints for analytics, inventory management, order access, customer export, and webhook data.
- [Orders & Subscriptions](https://docs.rmz.gg/storefront-api/orders.md): View customer orders, order details, VAT invoices, subscriptions, and submit order reviews.
- [Storefront API Overview](https://docs.rmz.gg/storefront-api/overview.md): Build custom storefronts for RMZ stores using the headless Storefront API.
- [Pages](https://docs.rmz.gg/storefront-api/pages.md): Retrieve custom store pages such as About Us, Terms of Service, and other static content.
- [Get Product Details](https://docs.rmz.gg/storefront-api/products/get-product.md): Retrieve a single product by slug, its subscription variants, and related products.
- [List & Search Products](https://docs.rmz.gg/storefront-api/products/list-products.md): Browse, filter, sort, and search the store's product catalog.
- [Product Reviews](https://docs.rmz.gg/storefront-api/products/product-reviews.md): Get product reviews and statistics, and submit reviews for purchased products.
- [Store Reviews](https://docs.rmz.gg/storefront-api/reviews.md): Get store-wide reviews, recent reviews, and review statistics.
- [Store Information](https://docs.rmz.gg/storefront-api/store.md): Retrieve store details, settings, currencies, features, and banners.
- [Wishlist](https://docs.rmz.gg/storefront-api/wishlist.md): Manage a customer's product wishlist.
- [Authentication](https://docs.rmz.gg/storefront-sdk/authentication.md): How the Storefront SDK authenticates requests using public keys, HMAC-SHA256 signatures, and Bearer tokens.
- [Cart](https://docs.rmz.gg/storefront-sdk/cart.md): Manage the shopping cart — add items, apply coupons, validate, and get summaries using sdk.cart.
- [Checkout](https://docs.rmz.gg/storefront-sdk/checkout.md): Create checkout sessions and handle payment results using sdk.checkout.
- [Configuration](https://docs.rmz.gg/storefront-sdk/configuration.md): All configuration options for the Storefront SDK — API URL, keys, timeouts, retries, caching, and logging.
- [Courses](https://docs.rmz.gg/storefront-sdk/courses.md): Access purchased courses, track progress, view modules, and mark completion using sdk.courses.
- [Customer Authentication](https://docs.rmz.gg/storefront-sdk/customer.md): Handle customer login via OTP, registration, profile management, and logout using sdk.auth.
- [Angular](https://docs.rmz.gg/storefront-sdk/frameworks/angular.md): Use the Storefront SDK with Angular as an injectable service.
- [React & Next.js](https://docs.rmz.gg/storefront-sdk/frameworks/react.md): Use the Storefront SDK with React and Next.js — hooks, SSR, API routes, and the official Next.js starter.
- [Vanilla JavaScript](https://docs.rmz.gg/storefront-sdk/frameworks/vanilla-js.md): Use the Storefront SDK via CDN or UMD bundle without any framework.
- [Vue 3](https://docs.rmz.gg/storefront-sdk/frameworks/vue.md): Use the Storefront SDK with Vue 3 Composition API and Nuxt.
- [Management, Pages & Components](https://docs.rmz.gg/storefront-sdk/management.md): Server-side management operations, static pages, and homepage components using sdk.management, sdk.pages, and sdk.components.
- [Orders](https://docs.rmz.gg/storefront-sdk/orders.md): Retrieve customer orders, subscriptions, and submit order reviews using sdk.orders.
- [Storefront SDK Overview](https://docs.rmz.gg/storefront-sdk/overview.md): Install and configure the RMZ Storefront SDK — a secure, framework-agnostic TypeScript SDK for building custom storefronts.
- [Products](https://docs.rmz.gg/storefront-sdk/products.md): Browse, search, and query products using sdk.products — including Firebase/Supabase-style method chaining.
- [Reviews](https://docs.rmz.gg/storefront-sdk/reviews.md): Retrieve store reviews, filter by rating, submit product reviews, and view statistics using sdk.reviews.
- [Store](https://docs.rmz.gg/storefront-sdk/store.md): Retrieve store information, currencies, settings, features, and banners using sdk.store.
- [Wishlist](https://docs.rmz.gg/storefront-sdk/wishlist.md): Manage the customer's wishlist — add, remove, check, and clear items using sdk.wishlist.
- [Webhook Events](https://docs.rmz.gg/webhooks/events.md): All webhook event types available in RMZ and what triggers them.
- [Webhooks Overview](https://docs.rmz.gg/webhooks/overview.md): Receive real-time notifications when events happen in your RMZ store.
- [Payload Format](https://docs.rmz.gg/webhooks/payload-format.md): Full JSON payload structure for RMZ webhook events.
- [Reliability & Retries](https://docs.rmz.gg/webhooks/reliability.md): How RMZ handles webhook delivery failures, retries, and logging.
- [Signature Verification](https://docs.rmz.gg/webhooks/signature-verification.md): Verify the authenticity of RMZ webhook deliveries using HMAC-SHA256 signatures.