API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

CustomerProductSubscriberStatus enum

Version unstable

Possible subscriber states of a customer defined by their subscription contracts.

Values

ACTIVE

The customer has at least one active subscription contract.

CANCELLED

The customer's last subscription contract was cancelled and there are no other active or paused subscription contracts.

EXPIRED

The customer's last subscription contract expired and there are no other active or paused subscription contracts.

FAILED

The customer's last subscription contract failed and there are no other active or paused subscription contracts.

NEVER_SUBSCRIBED

The customer has never had a subscription contract.

PAUSED

The customer has at least one paused subscription contract and there are no other active subscription contracts.

Types that return CustomerProductSubscriberStatus

Version 2021-01 (Release candidate)

Possible subscriber states of a customer defined by their subscription contracts.

Values

ACTIVE

The customer has at least one active subscription contract.

CANCELLED

The customer's last subscription contract was cancelled and there are no other active or paused subscription contracts.

EXPIRED

The customer's last subscription contract expired and there are no other active or paused subscription contracts.

FAILED

The customer's last subscription contract failed and there are no other active or paused subscription contracts.

NEVER_SUBSCRIBED

The customer has never had a subscription contract.

PAUSED

The customer has at least one paused subscription contract and there are no other active subscription contracts.

Types that return CustomerProductSubscriberStatus