Interface SubscriptionUsage

Current-period usage returned by GET /v1/subscriptions/usage.

The render/job counters are scoped to the subscriber's current billing cycle (not a calendar month). The trial* fields are present only while the entitlement is 'trialing' and drive "X of N trial credits used" messaging; they are omitted entirely for non-trial subscriptions.

interface SubscriptionUsage {
    periodJobs: number;
    periodRenderSpark: number;
    trialCreditsLimit?: number;
    trialCreditsUsed?: number;
    trialEndsAt?: string;
}

Properties

periodJobs periodRenderSpark trialCreditsLimit? trialCreditsUsed? trialEndsAt?

Properties

periodJobs

periodJobs: number

Number of paid jobs run in the current billing cycle.

periodRenderSpark

periodRenderSpark: number

Render spark consumed in the current billing cycle.

OptionaltrialCreditsLimit

trialCreditsLimit?: number

Total number of render credits granted for the free trial. Present only while the entitlement is 'trialing'.

OptionaltrialCreditsUsed

trialCreditsUsed?: number

Number of trial render credits consumed so far. Present only while the entitlement is 'trialing'.

OptionaltrialEndsAt

trialEndsAt?: string

ISO timestamp when the free trial ends. Present only while the entitlement is 'trialing'.

Settings

Member Visibility

On This Page

Properties