Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.stigg.io/llms.txt

Use this file to discover all available pages before exploring further.

Credit adjustments let you add or revoke credit grants for a customer outside of the normal purchase flow. Use them to load paid credit packs, issue promotional trial credits, correct mistakes, or remove remaining balances. Every change updates the customer’s credit pool and is written to the ledger for audit.
Credits can be granted to customers regardless of whether they have an active subscription. This makes it easy to seed new accounts with promotional credits before a plan is selected, or to issue credits to customers whose subscriptions have lapsed or haven’t started yet.Credit consumption, however, is still defined at the plan level and requires an active subscription. This decoupling will be extended to consumption in a future release.

​
Key concepts

  • Grant: a credit block with Amount, Priority, Cost basis, Effective date, Expiry date, Category (Paid / Promo), and Reason.
  • Priority: controls consumption order; lower value = higher priority (e.g., 0 is the highest).
  • Cost basis: price per credit for paid grants (used for finance).
  • Reason: optional, up to 200 characters, for internal context.

​
Create a grant (Stigg app)

  1. Go to Customers → [Customer] → Credits, then click Adjust credits balance.
  2. In Adjustment type, select Grant credits.
  3. Choose Resource (credit currency/type).
  4. Set Credit amount.
  5. In Grant method, choose one:
    • Purchase credits: set Per unit cost basis and select a Payment method.
    • Promo/Free granted: leave cost basis implicit at zero.
  6. (Optional) Open Schedule to set Effective date and/or Expiry date.
  7. Set Priority (remember: lower is higher priority; 0 is highest).
  8. (Optional) Add Reason (max 200 characters).
  9. Review the Summary (credits, total, previous/new balance) and click Grant Credits.
Result: A new grant appears in Grants; the Ledger records a Grant entry and the pool balance is updated.

​
Update a grant (dates, priority, reason)

Updating an existing grant is not currently supported via the Stigg app or the API. To change a grant’s effective date, expiry, priority, or reason, revoke the existing grant and create a new one with the desired settings.

​
Revoke a grant

Void a grant (or its remainder) to remove credits due to refunds, fraud, or policy changes.
  1. In Customers → [Customer] → Credits → Grants, open ⋯ and choose Revoke.
  2. Confirm the revocation and provide a Reason.
Result: The grant becomes unavailable; the Ledger records a Revocation entry and the pool balance is adjusted accordingly.

​
Create or revoke grants via API

You can perform the same actions programmatically (create paid or promotional grants, or revoke). Use your server-side integration to:
  • Issue paid grants after a successful charge or when an invoice is issued.
  • Issue promo grants during onboarding.
  • Revoke after refunds.
Updating an existing grant via the API is not currently supported. To modify a grant, revoke it and create a new one with the updated values.
Refer to the API reference for request fields that mirror the UI: currency/type, amount, cost basis, effectiveAt, expireAt, priority, reason.

​
Audit and troubleshoot

  • Ledger shows each change with Type, Delta, End balance, Actor, Reason.
  • Grants lists lifecycle and remaining vs. original amounts.
  • If a change isn’t visible, refresh the customer’s Credits tab and verify you edited the correct credit type.