Users Access
Available since: v1.0.0
🚧 In a busy system with millions of current or historic end user subscriptions the snapshot file will grow into multiple GB.
| File | Snapshot | Delta | Frequency |
|---|---|---|---|
| users_access/users_access_yyyy_MM_dd.csv | :white_check_mark: | :white_check_mark: | Daily |
| Attribute | Required? | Value | Description |
|---|---|---|---|
| ID | Yes | NUMBER | Unique identifier of entity |
| USER_ID | Yes | NUMBER | Foreign key for Users |
| STATUS_ID | NUMBER | 0 = Active (Access is valid for viewing content) 1 = Inactive 2 = Initialized (User has started, but not completed the purchase flow) 3 = Capture 4 = Free Access 5 = Stopped 6 = Upgraded (Access has been upgraded and is no longer used for access control) 7 = Auth_only (Only used for card authorization, does not grant access to view content) 8 = CAPTURE_QUEUED (The MemberAccess gets this state when it has been added to the queue for async processing) 9 = CAPTURE_IN_PROGRESS (This state is set when the MemberAccess has been fetched from the queue, and processing has started) 10 = CAPTURE_FAILED 11 = CAPTURE_REJECTED_DUPLICATE_PURCHASE (The processing of the MemberAccess was rejected since the user has an existing valid access) | |
| STATUS_TEXT | VARCHAR2(300 BYTE) | Describes last system update in text | |
| STARTDATE | DATE | Access is valid from this date | |
| ENDDATE | DATE | Access is attempted renewed on this date | |
| ACCESS_ENDDATE | DATE | Access is valid until this date (usually a few hours later than enddate, to allow job to run and account for temporary gateway hick-ups) | |
| USER_STOP_DATE | DATE | User cancelled subscription access on this date. | |
| PRICE | NUMBER | The user will be charged this amount on next enddate | |
| PERIOD | NUMBER | Access period in seconds. On “enddate” of the access, “period” number of seconds will be added to “enddate” if renewal is successful. | |
| AUTORENEW_STATUS | NUMBER | 0 = Active (This is a running subscription that will be attempted renewed on enddate) 1 = Stopping (Legacy status, no longer in active use) 2 = Stopped (This has been a running subscription, but has been stopped either by the enduser or by the system. It will not be attempted renewed on enddate) 3 = Stopped after errors (Legacy status, no longer in active use) 4 = Not started (Will only happen if status_id=2) 5 = Not eligible (This is not a running subscription - could be PPV, access granted through Admin or other non-renewable access types) 6 = Pending (Legacy status, no longer in active use) 7 = Converted (This subscription has been upgraded or downgraded, resulting in a new subscription with a different ID. It will not be attempted renewed on enddate) 8 = Stopped and expired (This has been a running subscription, but has been stopped either by the enduser or by the system. The access end date has passed, so it has expired) 9 = Converted and expired (This subscription has been upgraded or downgraded, resulting in a new subscription with a different ID. The access end date has passed, so it has expired) 10 = Frozen (This subscription has been frozen until a later time and will not be attempted renewed again until said time has passed) 11 = Single access expired (This is not a running subscription - could be PPV, access granted through Admin or other non-renewable access types. The access end date has passed, so it has expired) 12 = Frozen and expired (This subscription has been frozen until a later time and will not be attempted renewed again until said time has passed. The order was not unfrozen before the access end date passed, so it has expired) 13 = Expired (When the access end date has passed and the auto renew status is not Active, Stopped, Converted, Frozen or Not eligible, this is the fallback auto renew status) | |
| AUTORENEW_ERRORS | NUMBER | Number of times the access has failed autorenewal | |
| IP | VARCHAR2 | End user’s IP-address in moment of purchase | |
| PRODUCT_NAME | VARCHAR2 | Name of the product that defines the access | |
| ISP_ID | VARCHAR2 | End user’s ISP in moment of purchase | |
| REFERRER | VARCHAR2 | If third-party sites link into the service, they can pass along referrer, which is a free-text field. Front-ends must pass this through to the API if it is going to be logged. This field can then be used to calculate cuts | |
| PRODUCT_PROVIDER_ID | NUMBER | Foreign key for Product Providers | |
| LAST_PAYMENT_TRANSACTION_ID | NUMBER | Convenience reference to the last Payment Transactions on this subscription | |
| ASSET_ID | NUMBER | Foreign key for Assets. Front-ends can pass this along if a specific video triggered a purchase | |
| CATEGORY_ID | NUMBER | Foreign key for Categories. Front-ends can pass this along to log the category from which the purchase was made (might be relevant for bundles, to see which content triggers most purchases) | |
| PLATFORM_ID | NUMBER | Foreign key for Platforms. The platform (web, tablet etc) from which the purchase was made | |
| ORDER_REF | VARCHAR2(250 BYTE) | External reference of the subscription, typically from payment provider | |
| EXT_USER_ID | VARCHAR2(100 BYTE) | Logged for payment providers that require a username | |
| EXT_AGREEMENT_REF | VARCHAR2(250 BYTE) | External reference to subscription from payment providers (e.g. PayPal reference) used for autorenewals | |
| REGISTERED | DATE | Date the access was registered (might be earlier than startdate for sales made ahead of an event) | |
| LAST_ACTIVITY_DATE | DATE | The latest date the system did anything to the subscription (typically last auto renewal date). When registering a new order, this field is set to the same as “REGISTERED” | |
| PRODUCT_GROUP_ID | NUMBER | Convenience reference to the Product Groups (can also be deducted from product_provider_id) | |
| PRODUCT_ID | NUMBER | Convenience reference to the Products (can also be deducted from product_provider_id) | |
| VOUCHER_CODE | VARCHAR2(50 BYTE) | If the access was created with a voucher, the voucher code is logged here | |
| EARLIEST_ENDDATE | DATE | Used for subscriptions with a binding period. Even if the user stops the subscription, it will continue to be renewed until this date. | |
| ACTIVE_PERIODS | NUMBER | Number of periods the subscription has been running | |
| UPGRADED_FROM | NUMBER | When a subscription is upgraded, this field holds a reference to the original subscription | |
| CURRENCY | VARCHAR2(25 BYTE) | The currency of the subscription price | |
| PAYMENT_INFO | VARCHAR2(64 BYTE) | Can hold specific payment details such as masked credit card number | |
| PAYMENT_INFO_EXP_DATE | DATE | Typically holds credit card expiry date | |
| INIT_PRICE | NUMBER | Convenience reference to the first transaction price (if the subscription was purchased with a campaign) | |
| AUTO_RENEW_STOP_DATE | DATE | Final stop date for system renewal of a subscription. Will not be set unless the product has this specified | |
| APP_NAME | VARCHAR2(64 BYTE) | ||
| USER_PAYMENT_METHOD_ID | UUID | Foreign key for Users Payment Methods | |
| PERIOD_ISO | VARCHAR2 | (:new: v2.6.0+) Access period in ISO period format. | |
| EXTENDED_TIME | NUMBER | (:new: v2.11.0+) The amount of time in seconds the subscription has been extended with due to failed payments and a renew failure strategy that define a grace period. | |
| AUTORENEW_PROCESSING_STATUS | VARCHAR2(64 BYTE) | (:new: v2.11.0+) The status of the subscription’s renewal processing. IDLE: The subscription is not picked up for renewal. QUEUED: The subscription is queued for renewal. PROCESSING: The subscription is in the process of being charged for the next period. | |
| DEPLOYMENT_ENVIRONMENT_ID | VARCHAR2(64 BYTE) | (:new: v2.11.0+) String defining the originating environment of the subscription. Ensures that if one copies data from production to a stage environment, no subscription is to be charged twice. | |
| PAYMENT_METHOD | VARCHAR2(64 BYTE) | (:new: v2.11.0+) Defining the type of the payment object that goes along with the order when initialising the subscription. This will in most cases be closely related to the PaymentProvider in use. Can be one of the following: CREDITCARD, EXTERNAL_CREDITCARD, SMS, CREDENTIALS, REDIRECT, VOUCHER, ONE_CLICK_BUY, ONE_CLICK_BUY_PIN, CONVERT_ORDER_FOR_NEXT_RENEWAL, CONVERT_ORDER_INSTANTLY, EXTERNAL, GOOGLE_PLAY, INVOICE, DIRECT_BANK, IFLIX, EXTERNAL_CARRIER_BILLING, BRAINTREE, KLARNA, ALLOW_WITH_PASSWORD | |
| INITPRICE_AND_PERIOD_BYPASSED | CHAR(1) | (:new: v2.11.0+) “1” if bypassed. | |
| UPGRADE_OPTION | VARCHAR2(64 BYTE) | (:new: v2.11.0+) If subscription is upgraded, one of the following options will be used: EXTENDED_TIME, DISCOUNT, CHANGE_PAYMENT_INFO, CONVERT_WITHIN_SAME_PERIOD. | |
| UPGRADE_DISCOUNT | NUMBER | (:new: v2.11.0+) Discount given upon upgrade. | |
| UPGRADE_EXTENDED_TIME | NUMBER | (:new: v2.11.0+) Extended time given upon upgrade in seconds. | |
| TRIAL_OVERRIDE | VARCHAR2(64 BYTE) | (:new: v2.11.0+) If trial override have been used on initialisation of order, one of the following: TRIAL_FORCED, TRIAL_BYPASS_FORCED, FREE_TRIAL_BYPASSED otherwise DEFAULT. | |
| BASIS_FOR_RENEWAL_DATE_CALC | DATE | (:new: v2.11.0+) If Renewal End Date Calculation Strategy is set to SYNC_WITH_START_DATE, this date is used for calculating next renewal on subscriptions. |