API Reference

The Subscriber Object

Key Fields

Field

Description

uuid

A Supercast-generated unique identifier for this subscriber - all API calls can use this to identify a subscriber

email

Email address of the subscriber - all API calls can use this to identify a subscriber

customer_id

An external ID passed in when this subscriber was created (see Activate a Subscriber)

first_name

First name of the subscriber

last_name

Last name of the subscriber

subscriptions

A list of podcast subscriptions for this user (see Subscription object, below)

state

One of:

  • available - The subscriber's feeds are active
  • deactivated - The subscriber's feeds are cancelled
  • suspended - The subscriber is temporarily suspended due to manual action or suspicious feed activity
  • charge_failure - The subscriber's charges have failed and their feeds are temporarily suspended.
  • pending - The subscriber has initiated a checkout process but they have not been fully activated yet.

Additional Fields

FieldDescription
avatar_dataAvatar information for this subscriber (deprecating soon)
created_atDate this subscriber was created
idSupercast ID of this subscriber (deprecating soon)
ignore_usage_alertsWhen this is set to true, usage alerts will not be generated for this subscriber
updated_atMost recent update for this subscriber
plan_idThe plan this subscriber signed up for
plan_nameThe name of this subscriber's plan
plan_price_centsThe price of this subscriber's plan (all in only)
plan_price_currencyThe currency this subscriber is charged in (all in only)
time_zoneThe time zone of this subscriber (all in only)
player_linksA list of player links for this subscriber (deprecated - use the subscriptions array instead)
feed_urlA list of feed urls for this subscriber (deprecated - use the subscriptions array instead)