Subscription CSV
Overview
If you don't want to connect directly to a subscription datasource like Recharge, Recurly, Chargebee, or a similar software, you can export the data into a CSV and upload into Artifact. This document provides guidance on how the CSV should be formatted: both the required fields and optional metadata fields. It also goes over the optional, supplemental CSV you can upload for person metadata.
Sample Subscription CSV
Each of these fields will be covered in more depth, but here is an example of what a subscription CSV looks like. This example includes all of the required fields.
Subscription CSV column guidelines
Required columns
subscription_id: This is the unique ID for the subscription. The column is required and the value can't be null, an empty string, or contain any spaces.
person_id: This is the ID of the person with the subscription. The column is required and the field can’t be null or an empty string.
person_email: This is the person’s email address. The column is required, but can be left empty. If possible, please provide as it helps Artifact identify a user across all datasources.
subscription_status: This is the current status of subscription. Accepted values are Active, Cancelled, or Suspended. The column is required and can't be null.
subscription_start_date: This is the timestamp of the start of the subscription. The column is required and the field can't be null. The format should follow the ISO 8601 standard, as follows: 1990-01-15T00:34:60.026490+09:30.
subscription_end_date: This is the timestamp the subscription ended, or will end. The column is required; however, the value can be null or in the future. The format should follow the ISO 8601 standard, as follows: 1990-01-15T00:34:60.026490+09:30.
cancellation_date: This is the timestamp of when the subscription is no longer valid. The column is required; however, the field can be null. The format should follow the ISO 8601 standard, as follows: 1990-01-15T00:34:60.026490+09:30.
renewal_date: This is the timestamp of when the subscription is set to renew. The column is required; however, the field can be null. The format should follow the ISO 8601 standard, as follows: 1990-01-15T00:34:60.026490+09:30.
product: This is the product or package the subscription is for. The column is required; however, the field can be null.
Optional subscription metadata columns
If there is additional information about the subscription (but not the customer) that you want to filter by in Artifact, you can add columns with this information. For example, if I wanted to filter by subscription_value, I would add another column to the end of the CSV. It might look like this:
subscription_value |
$214.99 |
$780.00 |
When going through the CSV upload process, these columns will be left as unmapped.
Optional person metadata CSV
If there is additional information about the customer that you want to filter by in Artifact, this should NOT be added to the subscription CSV. Instead, once the subscription CSV has been uploaded, there will be a prompt to add a person metadata CSV. Think of this like a separate customer table in the same datasource.
Person metadata CSV required fields
person_id: This should be the same person_id that is used in the support CSV. The column is required and the value can’t be null, an empty string, or contain any spaces.
person_email: This is the email of the person. The column is required, but the value can be null or an empty string. Please note that this helps us conduct identify resolution across the different data sources so if possible, please provide it.
created_at: This is when the person was first seen or created within the support data. The column is required and the field can’t be null. The format should follow the ISO 8601 standard, as follows: 1990-01-15T00:34:60.026490+09:30.
updated_at: This is the timestamp for the last time the person was updated. The column is required and the field can’t be null. The format should follow the ISO 8601 standard, as follows: 1990-01-15T00:34:60.026490+09:30. If no updates have happened, then the value would be the same as the created_at field.
Optional metadata fields
After the required columns, any metadata that you want to filter on can be added. Some examples of person metadata that you would want to filter on include customer_state, customer_country, role, segment, or last_seen.
Important considerations for the subscription CSV
Subscription and person data don't count against your monthly interaction limit.