Skip to main content

What export options are available in the Subi Export Builder?

See all available export types in Subi Export Builder, with detailed field-by-field descriptions for each export file.

Updated over a week ago

Overview

You can export a wide range of data from the Subi Export Builder, including information about your subscriptions, customers, orders, and billing attempts. This article lists every export option currently available and describes the contents of each file. New export types will be added as they become available.


What subscription contract exports are available?

You can export detailed data about your subscription contracts managed within Subi. The following contract types can be exported as .csv files:

  • All contracts

  • Active contracts

  • Cancelled contracts

  • Expired contracts

  • Paused contracts

Each row in the export represents a line item, so contracts with multiple items will have a row for each item.

Note: In these exports, each row details the price and quantity of a single line item in a contract. If a contract includes multiple items, each item appears as a separate row.

In the exported file, you’ll see columns such as:

Column Header

Description

Data Format/Type

id

A globally unique identifier for the subscription contract.

Numeric ID

created_at

The date and time when the subscription contract was created.

ISO 8601 DateTime

status

The current status of the subscription contract (e.g., PAUSED, CANCELLED)

Text

next_billing_date

The date of the next scheduled billing for the contract.

ISO 8601 DateTime

line_count

The number of unique items (lines) in the contract.

Integer

delivery_price

The price for delivery, including amount and currency_code, as a JSON object.

JSON Object

billing_policy

JSON object describing billing intervals, max cycles, and minimum cycles.

JSON Object

delivery_policy

JSON object describing delivery intervals and counts.

JSON Object

delivery_method

JSON object containing delivery method details, including address information.

JSON Object

last_payment_status

Status of the last payment (e.g., SUCCEEDED, FAILED).

Text or Null

next_cycle_index

The index of the upcoming billing cycle.

Integer

initial_price_amount

The initial price of the subscription contract.

Decimal

origin_order_id

The ID of the order from which the contract originated.

Numeric ID or Null

currency_code

The ISO 4217 currency code for all monetary values (e.g., CAD).

Text

note

An optional note associated with the contract that will be applied to the generated orders.

Text or Null

discounts

A JSON array of discounts applied to the contract.

JSON Array

customer_id

The unique identifier for the customer associated with the contract.

Numeric ID

billing_policy_interval

The billing interval for the contract (e.g., WEEK, MONTH).

Text

billing_policy_interval_count

The number of intervals between billings.

Integer

delivery_policy_interval

The delivery interval for the contract (e.g., WEEK, MONTH).

Text

delivery_policy_interval_count

The number of intervals between deliveries.

Integer

delivery_method_typename

The type of delivery method for the contract (e.g., ADDRESS, PICKUP).

Text

delivery_method_address_*

Details about the delivery address (e.g., zip, city, name, phone, etc.).

Text or Null

customer_payment_method_*

Payment method details, including instrument type and revocation info.

Text or Null

line_*

Details about the line item, such as product title, variant, pricing, and quantity.

Varies

line_variant_image_src

The image URL of the variant for the line item.

URL

line_selling_plan_id

The unique identifier for the selling plan associated with the line.

Numeric ID

line_selling_plan_name

The name of the selling plan associated with the line (e.g., "Every 1 month").

Text

line_pricing_policy

JSON object describing base price and pricing policies.

JSON Object

line_pricing_policy_base_price_amount

The base price amount for the line item.

Decimal

line_pricing_policy_base_price_currency_code

The currency code for the line item base price (e.g., CAD).

Text

line_discount_allocations

A JSON array detailing any discounts applied to the line.

JSON Array


What is included in the Subscription Contracts: Changes Log (Events) export?

The Changes Log (Events) export provides a log of changes made to your subscription contracts, tracking events such as contract creation, updates, cancellations, and status changes.

Key columns you’ll find:

Column Header

Description

Data Format/Type

id

A globally unique identifier for the event log.

Numeric ID

subscription_contract_id

The unique identifier of the subscription contract associated with the event.

Numeric ID

created_at

The date and time when the event was created (e.g., 2024-12-29T09:37:20.206465Z).

ISO 8601 DateTime

log_level

The severity or type of log message (e.g., INFO, ERROR).

Text

actor

The entity responsible for the action (e.g., CUSTOMER, SYSTEM).

Text

event_label

A label describing the type of event (e.g., contract_created, contract_canceled).

Text

details

Additional details about the event, often including the status of the subscription contract or any changes.

JSON object or Text

message

A user-friendly message describing the event, such as "Customer canceled this subscription".

Text


What does the Customers export include?

The Customers export provides details about your customers and their current subscription status.

Column definitions:

Column Header

Description

Data Format/Type

id

A globally unique identifier for the customer.

Numeric ID

first_name

The customer's first name, if provided.

Text (nullable)

last_name

The customer's last name, if provided.

Text (nullable)

email

The customer's email address.

Text

state

The current account state of the customer (e.g., ENABLED, DISABLED).

Text

locale

The language and regional locale of the customer (e.g., en-CA, en-US).

Text


What is included in the Orders export?

The Orders export contains details about orders created through Subi, including their current status, pricing, and fulfillment details.

Column definitions:

Column Header

Description

Data Format/Type

id

A globally unique identifier for the order.

Numeric ID

name

The name or number of the order, typically prefixed by a hash (e.g., #1018).

Text

subscription_contract_id

The unique identifier of the associated subscription contract.

Numeric ID

created_at

The date and time when the order was created.

ISO 8601 DateTime

cancelled_at

The date and time when the order was canceled, if applicable.

ISO 8601 DateTime (nullable)

closed

Indicates whether the order is closed (true) or not (false).

Boolean

closed_at

The date and time when the order was closed, if applicable.

ISO 8601 DateTime (nullable)

fully_paid

Indicates whether the order is fully paid (true) or not (false).

Boolean

display_fulfillment_status

The current fulfillment status of the order (e.g., UNFULFILLED, FULFILLED).

Text

display_financial_status

The current financial status of the order (e.g., PAID).

Text

subtotal_price

The subtotal price for the order, excluding taxes (e.g., 22.14).

Decimal

total_price

The total price for the order, including taxes (e.g., 29.94).

Decimal

total_tax

The total amount of tax for the order (e.g., 0.0).

Decimal

taxes_included

Indicates whether taxes are included in the order’s total price (true) or not (false).

Boolean


What can I export with the Billing Attempts export?

The Billing Attempts export shows every attempt to bill a customer for a subscription contract, including the status, errors, and result.

Column definitions:

Column Header

Description

Data Format/Type

id

A globally unique identifier for the billing attempt.

Numeric ID

subscription_contract_id

Unique identifier of the associated subscription contract.

Numeric ID

created_at

The date and time when the billing attempt was initiated.

ISO 8601 DateTime

completed_at

The date and time when the billing attempt was completed.

ISO 8601 DateTime (nullable)

error_code

The error code for a failed billing attempt. Common values include AMOUNT_TOO_SMALL, AUTHENTICATION_ERROR, and INSUFFICIENT_FUNDS.

Text (nullable)

error_message

A descriptive message detailing any payment error that occurred during processing.

Text (nullable)

idempotency_key

The unique key generated by the client for the billing attempt to prevent duplicate payments.

Text

next_action_url

The URL where the customer needs to be redirected to complete actions like 3D Secure payment flows, if applicable.

Text (nullable)

ready

Indicates whether the billing attempt is still processing (false) or has completed (true).

Boolean

order_id

Unique identifier for the order resulting from a successful billing attempt.

Numeric ID

These descriptions align with the definitions provided in the Shopify API documentation. For more technical details, refer to the Shopify GraphQL Admin API documentation.

This article lists all export types currently available in Subi. If you have suggestions for additional export types, let us know!


Next Steps

For more information about managing exports and working with your data, see these related articles:


Need Help?

Feel free to contact our support team. We're here for you anytime:

  • Live Chat: Message us from within the Subi app or your Shopify Admin.

  • Email: Reach us at support@subi.co.

Did this answer your question?