File name: subscriptions.csv.zstd .
The subscriptions export contains all the subscriptions in Beat’s database.
| Field | Data type | Description |
|---|---|---|
subscription_id |
string | The subscription ID. |
user_id |
string | The user ID this subscription belongs to. Should always point to the primary user, not profiles. |
product_id |
string | The product ID this subscription represents. |
trial_start_date |
string (ISO 8601 datetime) | The date when the trial period started. Can be null. |
trial_end_date |
string (ISO 8601 datetime) | The date when the trial period concluded. Can be null. |
lock_start_date |
string (ISO 8601 datetime) | The date when a lock period started. Can be null. |
lock_end_date |
string (ISO 8601 datetime) | The date when a lock period ended. Can be null. |
start_date |
string (ISO 8601 datetime) | The date the subscription was started. Will often correspond to trial_start_date. |
stop_date |
string (ISO 8601 datetime) | The date the subscription was stopped. |
| `expiry_date`` | string (ISO 8601 datetime) | The date the subscription expires (and the user loses access). |
next_billing_date |
string (ISO 8601 datetime) | The date the subscription will be attempted renewed the next time. |
state |
string, one of trialing, |
|
active, renew_failure, |
||
stopped, deactivated, |
||
unpaid, |
||
incomplete, |
||
incomplete_expired, |
||
unknown |
The status of the subscription. See the document on subscription states. | |
is_granting_access |
boolean | Indicates whether the subscription is currently granting the user access to the product. This is at the time of this writing only checking if expiry_date is null or in the future. |
partner_name |
string | The name of the partner that owns the subscription through the partner API. Not set means the subscription is managed by the user. |