Skip to main content
All CollectionsSubscription Management
Available exports in the Subi Export Builder
Available exports in the Subi Export Builder

Explore all available export options in the Subi Export Builder

Updated over a week ago

Overview

This guide provides a complete list of exports available in the Subi Export Builder. As new export types become available, they will be added to this list.


Subscription contracts (.csv)

  • All

  • Active

  • Cancelled

  • Expired

  • Paused

These exports provides detailed data about subscription contracts managed within the Subi subscription app.

In the subscription contract exports, each row in the csv file represents a line item, which details the price and quantity of a single item in a subscription contract. If a subscription contract includes multiple items, there will be a corresponding row for each item in the table.

Below are the column descriptions:

Column Header

Description

Data Format/Type

id

Unique identifier for the contract.

Numeric ID

created_at

Timestamp when the contract was created.

ISO 8601 DateTime

status

Current status of the contract (e.g., PAUSED, CANCELLED).

Text

next_billing_date

Scheduled date for the next billing cycle.

ISO 8601 DateTime

line_count

Number of unique items(lines) included in the contract.

Integer

delivery_price

Price of delivery in JSON format containing amount and currency_code.

JSON Object

billing_policy

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

JSON Object

delivery_policy

JSON describing delivery intervals and counts.

JSON Object

delivery_method

JSON 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

Index of the upcoming billing cycle.

Integer

initial_price_amount

Initial price of the subscription contract.

Decimal

origin_order_id

The order from which this contract originated.

Numeric ID or Null

currency_code

Currency code for all monetary values (e.g., CAD).

Text

note

Optional notes that will be applied to the generated orders.
​

Text or Null

discounts

JSON array listing applied discounts.

JSON Array

customer_id

Unique ID for the customer associated with the contract.

Numeric ID

billing_policy_interval

Frequency of billing intervals (e.g., WEEK, MONTH).

Text

billing_policy_interval_count

Number of intervals between billings.

Integer

delivery_policy_interval

Frequency of delivery intervals (e.g., WEEK, MONTH).

Text

delivery_policy_interval_count

Number of intervals between deliveries.

Integer

delivery_method_typename

Type of delivery method (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 (see below)

line_variant_image_src

URL of the line variant image.

URL

line_selling_plan_id

ID of the selling plan associated with the line.

Numeric ID

line_selling_plan_name

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

Text

line_pricing_policy

JSON describing base price and pricing policies.

JSON Object

line_pricing_policy_base_price_amount

Base price amount of the line.

Decimal

line_pricing_policy_base_price_currency_code

Currency code of the base price (e.g., CAD).

Text

line_discount_allocations

JSON array detailing any discounts applied to the line.

JSON Array


Subscription Contracts: Changes Log (Events)

This export provides a log of changes made to subscription contracts, tracking events like contract creation, updates, cancellation, and status changes.

Below are the column descriptions:

Column Header

Description

Data Format/Type

id

Unique identifier for the event log.

Numeric ID

subscription_contract_id

Unique identifier of the subscription contract associated with the event.

Numeric ID

created_at

Timestamp when the event was logged.

ISO 8601 DateTime (e.g., 2024-12-29T09:37:20.206465Z)

log_level

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


Customers:

This export provides information about customers, including their basic details and subscription state.

Below are the column descriptions:

Column Header

Description

Data Format/Type

id

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 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


Orders

This export provides detailed information about orders, including their statuses, pricing, and fulfillment details.

Below are the column descriptions:

Column Header

Description

Data Format/Type

id

Unique identifier for the order.

Numeric ID

name

Order name or number, typically prefixed by a hash (e.g., #1018).

Text

subscription_contract_id

Unique identifier of the associated subscription contract.

Numeric ID

created_at

Timestamp when the order was created.

ISO 8601 DateTime

cancelled_at

Timestamp when the order was canceled, if applicable.

ISO 8601 DateTime (nullable)

closed

Boolean value indicating whether the order is closed.

Boolean

closed_at

Timestamp when the order was closed, if applicable.

ISO 8601 DateTime (nullable)

fully_paid

Boolean value indicating whether the order is fully paid.

Boolean

display_fulfillment_status

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

Text

display_financial_status

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

Text

subtotal_price

The subtotal price of the order, excluding taxes.

Decimal (e.g., 22.94)

total_price

The total price of the order, including taxes.

Decimal (e.g., 29.14)

total_tax

The total tax amount applied to the order.

Decimal (e.g., 0.0)

taxes_included

Boolean value indicating whether taxes are included in the price.

Boolean


Billing Attempts

This export provides detailed records of each attempt to bill a customer under a subscription contract, including timestamps, statuses, and any errors encountered during the process.

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

A code corresponding to a payment error encountered during processing. Possible values include AMOUNT_TOO_SMALL, AUTHENTICATION_ERROR, INSUFFICIENT_FUNDS, among others.

Text (nullable)

error_message

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

Text (nullable)

idempotency_key

A unique key generated by the client 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. If you have further questions, check Shopify GraphQL Admin API documentation.

Did this answer your question?