User Subscription

Type: object

ONBRDNG Schema for a user_subscription

The following properties are required:

root id
Type: string

Unique Identifier for a User Subscription

root user_id
Type: string

Foreign key for User

root subscription_id
Type: string

Foreign key for Subscription

root campaign
Type: string

unique identifier for a campaign

root state
Type: enum (of string)

The User State, ie active or inactive.

Must be one of:

  • "active"
  • "inactive"

root created_at
Type: stringFormat: date-time

Moment of User Subscription creation. Format: YYYY-MM-DD HH:MM:SS[.SSSSSS].

Must match regular expression: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?Z?$

root starts_at
Type: stringFormat: date

The User Subscription start date.

Must match regular expression: ^\d{4}-\d{2}-\d{2}$

root expires_at
Type: stringFormat: date

The User Subscription expiration date.

Must match regular expression: ^\d{4}-\d{2}-\d{2}$

root suspended_at
Type: stringFormat: date-time

Moment of User Subscription suspension. Format: YYYY-MM-DD HH:MM:SS[.SSSSSS].

Must match regular expression: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?Z?$

root stacked_user_subscription_id
Type: string

Key for linked User Subscription

root reseller
Type: string

The Reseller of the User.