Granting Products

Sometimes you need to give a customer a product without charging them - comps, promotional offers, or support access. Use grantProduct on the server. There is no grant-product button in the dashboard — from the dashboard, use Create checkout (even in test mode) or adjust item quantities. A grant creates a real subscription or one-time product on the customer. It does not honor a configured free trial — access starts immediately. Pass quantity for stackable products (defaults to 1).

Granting a configured product

import { hexclaveServerApp } from "@/hexclave/server";

// Grant a pre-configured product to a user
await hexclaveServerApp.grantProduct({
  userId: "user-id",
  productId: "prod_premium",
  quantity: 1,
});

// Grant to a team
await hexclaveServerApp.grantProduct({
  teamId: "team-id",
  productId: "prod_team_plan",
});

// Grant to a custom customer
await hexclaveServerApp.grantProduct({
  customCustomerId: "external-org-123",
  productId: "prod_enterprise",
});

If you already have a reference to a server user or team object (for example from hexclaveServerApp.getUser(userId)), you can also call user.grantProduct({ productId, quantity }) directly. This method is server-only.

Inline products

You can also grant products with an inline definition - no pre-configured product needed. This is useful for one-off grants like bonus credits:

import { hexclaveServerApp } from "@/hexclave/server";

await hexclaveServerApp.grantProduct({
  userId: "user-id",
  product: {
    display_name: "Bonus Credits",
    customer_type: "user",
    server_only: true,
    stackable: false,
    prices: {
      manual: { USD: "0" },
    },
    included_items: {
      credits: { quantity: 100 },
    },
  },
});

Items & Entitlements - the credits and seats a grant hands out
Checkout & Purchases - charge the customer instead
Customer Types - grant to users, teams, or custom customers

Getting Started

Going Further

Apps

Integrations

Other

Granting a configured product

Inline products

​Granting a configured product

​Inline products

​Related

Granting a configured product

Inline products

Related