Enums

This page documents the common enum types used across the Stigg GraphQL API.

Subscription Enums

SubscriptionStatus

Status of a customer subscription.

Value	Description
ACTIVE	Subscription is active and billing
IN_TRIAL	Subscription is in trial period
CANCELED	Subscription has been cancelled
EXPIRED	Subscription has expired
NOT_STARTED	Subscription is scheduled but not started
PAYMENT_PENDING	Awaiting payment confirmation

SubscriptionCancelReason

Reason why a subscription was cancelled.

Value	Description
Immediate	Cancelled immediately by request
ScheduledCancellation	Scheduled to cancel at end of period
TrialEnded	Trial period ended without conversion
TrialConverted	Trial converted to paid (old subscription cancelled)
UpgradeOrDowngrade	Plan was changed
Expired	Subscription reached its end date
CustomerArchived	Customer was archived
CancelledByBilling	Cancelled by billing provider
AutoCancellationRule	Cancelled by auto-cancellation rule
PendingPaymentExpired	Payment was not completed
DetachBilling	Billing integration was detached

SubscriptionCancellationTime

When a subscription cancellation takes effect.

Value	Description
IMMEDIATE	Cancel immediately
END_OF_BILLING_PERIOD	Cancel at end of billing period
SPECIFIC_DATE	Cancel on a specific date

Billing Enums

BillingModel

How pricing is calculated.

Value	Description
FLAT_FEE	Fixed price regardless of usage
PER_UNIT	Price per unit (e.g., per seat)
USAGE_BASED	Price based on metered usage
CREDIT_BASED	Price based on credit consumption
MINIMUM_SPEND	Minimum spend commitment

BillingPeriod

Frequency of billing.

Value	Description
MONTHLY	Billed every month
ANNUALLY	Billed every year

BillingCadence

When billing occurs within the period.

Value	Description
IN_ADVANCE	Billed at the start of the period
IN_ARREARS	Billed at the end of the period

TiersMode

How tiered pricing is applied.

Value	Description
VOLUME	All units are charged at the tier rate for the total volume
GRADUATED	Each tier has its own rate, applied progressively

PaymentCollection

Payment collection status.

Value	Description
NOT_REQUIRED	No payment required
PROCESSING	Payment is being processed
PAID	Payment completed
FAILED	Payment failed
ACTION_REQUIRED	Customer action required

Package Enums

PackageStatus

Publication status of plans and addons.

Value	Description
DRAFT	Package is in draft, not available for subscription
PUBLISHED	Package is published and available
ARCHIVED	Package is archived and no longer available

PricingType

Type of pricing for a package.

Value	Description
FREE	No charge
PAID	Requires payment
CUSTOM	Custom pricing (negotiated)

Feature Enums

FeatureType

Type of feature.

Value	Description
BOOLEAN	Feature is either enabled or disabled
NUMBER	Feature has a numeric limit or quantity
ENUM	Feature has a set of possible values

FeatureStatus

Status of a feature.

Value	Description
ACTIVE	Feature is active
INACTIVE	Feature is inactive

MeterType

Type of metering for usage tracking.

Value	Description
FLUCTUATING	Value can increase or decrease
INCREMENTAL	Value only increases
NONE	No metering

Entitlement Enums

EntitlementResetPeriod

How often usage resets.

Value	Description
HOUR	Resets hourly
DAY	Resets daily
WEEK	Resets weekly
MONTH	Resets monthly
YEAR	Resets yearly

AccessDeniedReason

Reason why access to a feature was denied.

Value	Description
CustomerNotFound	Customer does not exist
CustomerIsArchived	Customer is archived
CustomerResourceNotFound	Resource not found
FeatureNotFound	Feature does not exist
FeatureTypeMismatch	Wrong entitlement type requested
NoActiveSubscription	No active subscription
NoFeatureEntitlementInSubscription	Feature not included in subscription
RequestedUsageExceedingLimit	Usage would exceed limit
RequestedValuesMismatch	Values don’t match allowed values
BudgetExceeded	Usage budget exceeded
InsufficientCredits	Not enough credits
Revoked	Entitlement was revoked
Unknown	Unknown reason

Coupon Enums

CouponType

Type of discount.

Value	Description
PERCENTAGE	Discount is a percentage off
FIXED	Discount is a fixed amount

CouponStatus

Status of a coupon.

Value	Description
ACTIVE	Coupon is active and can be used
ARCHIVED	Coupon is no longer available

CouponSource

Where the coupon was created.

Value	Description
STIGG	Created in Stigg
BILLING	Synced from billing provider

Credit Enums

CreditGrantType

Type of credit grant.

Value	Description
PROMOTIONAL	Free promotional credits
PAID	Credits purchased by customer
ROLLOVER	Credits rolled over from previous period
SUBSCRIPTION	Credits from subscription

CreditGrantStatus

Status of a credit grant.

Value	Description
PENDING	Grant is pending activation
ACTIVE	Credits are available
CONSUMED	All credits consumed
EXPIRED	Grant has expired
VOIDED	Grant was voided

CreditGrantCadence

When credits are granted.

Value	Description
BEGINNING_OF_BILLING_PERIOD	At start of billing period
MONTHLY	Every month

Plan Change Enums

PlanChangeType

Type of plan change.

Value	Description
UPGRADE	Upgrading to a higher tier plan
DOWNGRADE	Downgrading to a lower tier plan
NONE	No change (same plan)

Widget Enums

WidgetType

Types of customer-facing widgets.

Value	Description
PAYWALL	Pricing/paywall widget
CUSTOMER_PORTAL	Customer portal widget
CHECKOUT	Checkout widget