Status values of the UserSubscription object

Lowercase form — returned by /publisher/subscription/get and /publisher/subscription/list.
Short code — returned by /publisher/subscription/stats and /publisher/subscription/details.
Uppercase form — used in the subscription_created, subscription_updated, subscription_renewal, and subscription_ended webhooks.

Lowercase form	Short code	Uppercase form	Meaning
`na`	`NA`	—	Not applicable / unknown.
`active`	`A`	`ACTIVE`	Subscription is currently active.
`cancelled`	`C`	`CANCELLED`	Subscription was cancelled (immediate).
`fail_and_retry`	`FAR`	`FAIL_AND_RETRY`	Payment failure; renewal will be retried (typically in grace period).
`expired_with_error`	`EWE`	`EXPIRED_WITH_ERROR`	Expired because payment ultimately couldn’t be collected.
`expired`	`E`	`EXPIRED`	Naturally expired (e.g., auto-renew off, no further period).
`completed`	`END`	`COMPLETED`	Won’t renew; subscription will end at the next bill date.
`deleted`	`D`	—	Soft-deleted.
`wait_confirmed`	`WC`	—	Awaiting confirmation (e.g., async payment provider).
`upgraded`	`UPGRD`	`UPGRADED`	Replaced by a newer subscription via upgrade.
`pending`	`P`	`PENDING`	Pending state (e.g., between purchase and activation).
`not_started`	`NS`	`NOT_STARTED`	Future-start subscription, not yet active.

The values na, deleted, and wait_confirmed do not appear in webhook payloads — they are internal states only.

The list endpoints /publisher/subscription/list and /publisher/sharedSubscription/list accept a status query parameter for filtering results. This parameter is unrelated to the status field of the UserSubscription object — it takes a separate set of input filter labels: active, failedAndRetry, cancelled, paymentFailure, expired, renewed, completed, and upgraded. Each filter label maps to one or more underlying status values from the table above.

Last updated: July 01, 2026