Maxio’s CSV export feature enables you to extract key business data—Subscriptions, Customers, Transactions, Products, Components, and Tax History—for integration, reporting, and audit purposes. This reference lists every field included in the most common CSV export types, explains their meanings, and shows how to leverage them effectively.
See also: Exporting Data
Billing Export
Subscription Fields
To include components in your Subscription exports, enable this option in your CSV export settings. Visit this article to learn more. This setting currently applies only to Subscription exports.
| Field | Description | Column |
|---|---|---|
id |
The subscription ID | A |
customer_id |
The ID of an existing customer within Advanced Billing | B |
customer_reference |
The reference value (provided by you) of an existing customer within Advanced Billing | C |
customer_name |
The full name of your Subscriber | D |
customer_email |
The email address of your Subscriber | E |
state |
The current state of the subscription. Please see the documentation for Subscription States | F |
product_id |
The Product ID of the product for which the Subscription exists | G |
next_product_id |
If a delayed product change is scheduled, the ID of the product that the subscription will be changed to at the next renewal | H |
product_name |
The given name of the product | I |
recurring_price |
The recurring price of the product | J |
recurring_interval |
The recurring interval of the product. Expressed in number of months or days | K |
recurring_interval_unit |
The unit of recurring period. Will be day or month
|
L |
coupon |
A list of coupon codes attached to the subscription. It will be blank if the subscriber has no coupons. | M |
created_at |
The timestamp of the creation of the subscription | N |
created_at_day |
The day of the month in which the subscription was created | O |
created_at_month |
The month in which the subscription was created | P |
created_at_year |
The year in which the subscription was created | Q |
current_period_starts_at |
Timestamp relating to the start of the current (recurring) period | R |
current_period_ends_at |
Timestamp relating to the end of the current (recurring) period (i.e.,when the next regularly scheduled attempted charge will occur) | S |
next_assessment_at |
Timestamp that indicates when capture of payment will be tried or retried | T |
trial_started_at |
Timestamp for when the trial period (if any) began | U |
trial_ended_at |
Timestamp for when the trial period (if any) ended | V |
activated_at |
The timestamp in which the subscription was activated | W |
expires_at |
Timestamp giving the expiration date of this subscription (if any) | X |
canceled_at |
The timestamp in which the subscription was canceled | Y |
canceled_at_day |
The day of the month in which the subscription was canceled | Z |
canceled_at_month |
The month in which the subscription was canceled. | AA |
canceled_at_year |
The year of cancelation | AB |
cancellation_message |
The cancelation reason/message | AC |
balance_in_cents |
The current balance in cents | AD |
balance |
The current balance | AE |
revenue_in_cents |
The total payments in cents on the subscription. This value is not strictly revenue | AF |
revenue |
The total amount of payments on the subscription. This value is not strictly revenue | AG |
credit_card_masked_number |
The masked credit card on file. E.g. XXXX-XXXX-XXXX-1111 | AH |
credit_card_type |
The type of credit card | AI |
credit_card_first_name |
The first name listed on the credit card | AJ |
credit_card_last_name |
The last name listed on the credit card | AK |
credit_card_expiration_month |
The expiration month of the credit card on file | AL |
credit_card_expiration_year |
The expiration year of the credit card on file | AM |
credit_card_vault |
The location of the credit card token | AN |
credit_card_vault_token |
The credit card token | AO |
credit_card_customer_vault_token |
The credit card token. Used only by Authorize.Net | AP |
credit_card_billing_address |
The credit card or bank account billing street address (i.e. “123 Main St.”). | AQ |
credit_card_billing_address_2 |
Second line of the customer’s billing address i.e. “Apt. 100” | AR |
credit_card_billing_city |
The credit card or bank account city billing address | AS |
credit_card_billing_state |
The credit card or bank account state billing address | AT |
credit_card_billing_zip |
The credit card or bank account zip code | AU |
credit_card_billing_country |
The credit card or bank account billing address country, in ISO 3166-1 alpha-2 format (i.e. “US”). | AV |
shipping_address |
The shipping address | AW |
shipping_address_2 |
Second line of the customer’s shipping address i.e. “Apt. 100” | AX |
shipping_city |
The shipping city portion of the address | AY |
shipping_state |
The shipping state portion of the address | AZ |
shipping_zip |
The shipping zip portion of the address | BA |
shipping_country |
The shipping country portion of the address | BB |
customer_organization |
The customer’s organization | BC |
customer_phone |
The customer’s phone number | BD |
cancel_at_end_of_period |
True/false: if the subscription is set to cancel at the end of the current billing period | BE |
delayed_cancel_at |
Timestamp for when the subscription is currently set to cancel. expires_at Timestamp giving the expiration date of this subscription (if any) | BF |
product_version_number |
The version of the product the subscriber has purchased. Example: 80. 29, 31 | BG |
updated_at |
The timestamp of the most recent update to the subscription | BH |
referral_code |
BI | |
state_changed_at |
The timestamp of the most recent subscription state change | BJ |
cancellation_method |
The process used to cancel the subscription, if the subscription has been canceled. Can be one of merchant_ui, merchant_api, dunning, unknown, or billing_portal. |
BK |
reason_code |
The specific churn reason code provided during cancellation of the subscription; it will appear when the subscription is already canceled or scheduled to be canceled at the end of the period. If no churn code was provided at the time of cancellation, this field will have the value “CH:Unknown.” If the subscription is not yet canceled, this field will be blank. | BL |
payment_collection_method |
The payment collection method for the subscription. Automatic, Remittance, or Prepaid | BM |
payment_profile_type |
The type of payment the subscription is using. CreditCard (default) or ACH. | BN |
bank_name |
The name of the bank being used if ACH. | varies |
bank_routing_masked_number |
The masked routing number of the bank being used for ACH. | varies |
bank_account_masked_number |
The makes account number of the account being used for ACH. | varies |
bank_account_type |
The account type of the ACH account. Checking or savings. | varies |
bank_account_holder_type |
The type of account holder for the ACH account. Personal or business. | varies |
paypal_email |
The paypal email address of a paypal paid subscription. Available on sites with paypal payment enabled. | varies |
subscription_group_uid |
(Optional) The UID of the subscription group of which this subscription is a member. It will be empty if the subscription does not belong to a group. This is only available for sites using Relationship Billing. | varies |
currency |
The currency in which a subscription is billed. | varies |
currency_symbol |
The symbol associated with the the currency in which a subscription is billed. | varies |
product_price_point_id |
The ID of the subscription’s current product price point. | varies |
product_price_point_name |
The name of the subscription’s current product price point. | varies |
reference |
A custom identifier that can be attached to the subscription. | |
next_product_price_point_id |
The ID of the subscription’s next product price point. | varies |
Sales Rep ID |
The ID of the Sales Representative | varies |
Sales Rep Name |
The Name of the Sales Representative | varies |
scheduled_cancellation_at |
The date on which the subscription is scheduled to cancel | varies |
prepaid_dunning |
Indicates whether the subscription is prepaid and currently in dunning. Only returned on Relationship Invoicing sites. | varies |
site_gateway_setting_ID |
The ID of the gateway connected to your site | |
gateway_handle |
The custom handle of the gateway connected to your site | |
custom_fields |
A specific column that indicates the title of the custom field will be added if this is enabled in the custom field CSV settings. Each custom field will be a separate column. | |
Estimated Renewal Amount |
(Optional) This is the anticipated next billing amount, based on the current plan and configuration (taxes, components, discounts, etc.) You can enable this option under Settings –> CSV exports | varies |
Component name & ID |
(Optional) A separate column will be added for each individual component in your site. Each column will be populated with the total number of currently allotted component. You can enable this option under Settings –> CSV exports | varies |
Last Amount Invoiced In Cents |
(Optional) This column reflects the total amount billed, in cents, on the most recent invoice that was not generated mid-period per subscriber. You can enable this option under Settings –> CSV exports | varies |
Customer Fields
| Field | Description | Column |
|---|---|---|
id |
The unique identifier for this customer within Advanced Billing. This is the ID displayed in the customer tab | A |
first_name |
The first name of the customer | B |
last_name |
The last name of the customer | C |
organization |
Company/Organization name | D |
email |
The email address of the customer | E |
created_at |
The creation date for this customer. E.g: 2016-06-03 12:43:50 -0400
|
F |
reference |
The unique identifier used within your own application for this customer | G |
address |
The customer’s shipping street address (i.e. “123 Main St.”). | H |
address_2 |
Second line of the customer’s shipping address i.e. “Apt. 100” | I |
city |
The customer’s shipping address city (i.e. “Boston”). | J |
state |
The customer’s shipping address state (i.e. “MA”) | K |
zip |
The customer’s shipping address zip code (i.e. “12345”) | L |
country |
The customer shipping address country, preferably in ISO 3166-1 alpha-2 format (i.e. “US”). | M |
phone |
The phone number of the customer | N |
created_at |
TBD | O |
updated_at |
The date of last update for this customer | P |
cc_emails |
Additional email addresses that will communications | Q |
tax_exempt |
If the customer is tax exempt | R |
vat_number |
The customer’s VAT number | S |
ach_verified |
If the customer has been verified for ach payment (only if site is ach enabled AND on authoriznet gateway ) | T |
custom_fields |
Each customer custom field marked to appear on CSV exports will be included in a separate column. | varies |
Invoice Line Items Fields
The Invoice Line Items export consists of the line items for each invoice issued on our Invoicing architecture between the requested dates, with the following columns.
| Field | Description | Column |
|---|---|---|
invoice_uid |
The ID of the Invoice this line item belongs to (see API: Invoices ) | A |
invoice_number |
The unique (to this site) identifier for the invoice | B |
invoice_issue_date |
The date that the invoice was issued to the customer | C |
invoice_status |
The current status of the Invoice (ie. open, paid, etc) | D |
customer_id |
The customer’s unique ID within Advanced Billing | E |
customer_name |
The customer’s name | F |
payer_customer_id |
The payer’s unique ID within Advanced Billing | G |
payer_name |
The payer’s name | H |
subscription_id |
The subscription’s unique ID within Advanced Billing | I |
item_id |
The item’s unique id within Advanced Billing (reference the associated item_type) | J |
item_name |
The item’s name | K |
item_type |
The item’s type (ie. product, component, or credit) |
L |
kind |
The kind of item. For components: the component’s type. For products: base_fee, setup, or trial_period.For credits: service_credit, refund, proration, void, and backport
|
M |
item_memo |
The item’s memo description (only for credits) | N |
price_point_id |
The price point’s unique ID within Advanced Billing (only for components) | O |
unit_price |
The price per unit (only for products and components) | P |
quantity |
The number of units charged for by the invoice (only for products and components) | Q |
subtotal_amount |
The subtotal for the line item | R |
discount_amount |
The total of any discounts for the line item | S |
coupon_codes |
A list of coupons applied to the invoice | T |
tax_amount |
The amount of tax applicable to the line item | U |
total_amount |
The total charge for the line item | V |
period_range_start |
The start date for the subscription period | W |
period_range_end |
The end date for the subscription period | X |
currency |
The currency in which a subscription is billed | Y |
currency_symbol |
The symbol associated with the the currency in which a subscription is billed | Z |
transaction_id |
The transaction unique ID within Advanced Billing | AA |
customer_organization |
The customer’s organization | AB |
net_terms |
The number of days after a subscription renews before that subscription’s automatic payment will collect | AC |
taxable_amount |
The taxable amount | AD |
tax_exempt_amount |
The tax exempt amount | AE |
invoice_due_amount |
The amount still due on the invoice | AF |
invoice_paid_amount |
The total amount paid on the invoice | AG |
invoice_paid_date |
The date the invoice was paid in full | AH |
Transaction Fields
| Field | Description | Column |
|---|---|---|
subscription_id |
Unique identifier of the subscription associated with the transaction | A |
subscription_group_id |
The ID of the subscription group of which this subscription is a member. It will be empty if the subscription does not belong to a group. | B |
customer_id |
Unique identifier of the customer associated with the transaction | C |
customer_reference |
The reference value (provided by you) of an existing customer within Advanced Billing | D |
transaction_id |
The identifier for the transaction prefixed with the type of transaction - invoice: INV, payment: PMT, credit: CN, refund: RFD |
E |
uid |
Unique identified of the transaction. This value is unique across across transaction types and sites. | F |
customer |
The Organization name of the customer if available, otherwise the customer First and Last name will be displayed | G |
customer_email |
The email address of your customer | H |
address |
The customer’s shipping street address (i.e. “123 Main St.”) | I |
address2 |
Second line of the customer’s shipping address (i.e. “Apt. 100”) | J |
city |
The customer’s shipping address city (i.e. “Boston”) | K |
state |
The customer’s shipping address state (i.e. “MA”) | L |
zip |
The customer’s shipping address zip code (i.e. “12345”) | M |
country |
The customer shipping address country, preferably in ISO 3166-1 alpha-2 format (i.e. “US”) | N |
gateway_transaction_id |
A gateway-specific identifier for the transaction | O |
payer_customer_id |
The payer’s unique ID within Advanced Billing | P |
payer_customer_reference |
The payer’s reference value (provided by you) within Advanced Billing | Q |
payer_name |
The payer’s name | R |
payer_organization |
The payer’s Company/Organization name | S |
payment_method |
The payment method utilized (i.e. credit card, external) | T |
credit_card_last_4 |
The last four digits of the credit card for payment transactions | U |
transaction_date |
The date of the transaction. For invoices the issue date is displayed, payment/credits/refunds will display the creation date. | V |
due_date |
The invoices due date | W |
created_date |
The timestamp of the transaction creation | X |
type |
The type of transaction. Following are the options: invoice, payment, credit, refund
|
Y |
subtype |
An attribute noting how each transaction is generated. Following are the options: Invoice – automatic, remittance Payments – automatic, external, prepayment Credits – migration, component downgrade, void, refund, service, general Refunds – regular, external |
Z |
product |
The name of the product associated with the subscription | AA |
memo |
A note about the transaction | AB |
status |
Indicates whether or not the transaction was successful | AC |
subtotal |
The amount of the transaction related to product and component charges | AD |
discount |
The amount of discount included in the transaction | AE |
taxes |
The amount of tax applicable to the transaction | AF |
amount |
The total amount for the transaction | AG |
amount_due |
The amount still due on the invoice | AH |
currency |
The ISO currency (e.g. USD) of the transaction | AI |
currency_symbol |
The currency symbol (e.g. $) of the transaction | AJ |
consolidation_level |
Indicates if the invoice transaction is consolidated | AK |
site_gateways_setting_id |
The ID of the gateway connected to your site | |
gateway_handle |
The custom handle of the gateway connected to your site | |
status_description |
Description of the status of the transaction |
Product and Tax Exports
Product Fields
The products export does not contain information on components or coupons. If you need information of this type, we recommend using our API to send a GET request to optain a list of your current products or coupons.
| Field | Description | Column |
|---|---|---|
id |
The product ID | A |
name |
The product name | B |
handle |
The product API handle | C |
description |
The product description | D |
accounting_code |
The product family accounting code (has no bearing in Advanced Billing, may be used within your app) | E |
product_family_id |
ID of product family within Advanced Billing | F |
product_family_name |
Nested attributes pertaining to the product family to which this product belongs | G |
product_family_description |
Description of product family | H |
expiration_interval |
A numerical interval for the length a subscription to this product will run before it expires. See the description of interval for a description of how this value is coupled with an interval unit to calculate the full interval |
I |
expiration_interval_unit |
A string representing the trial interval unit for this product, either month or day
|
J |
return_url |
The url to which a customer will be returned after a successful signup | K |
update_return_url |
The url to which a customer will be returned after a successful account update. | L |
created_at |
Timestamp of the creation of the product | M |
price_in_cents |
The product price, in integer cents | N |
interval |
The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of ‘day’ would mean this product would renew every 30 days |
O |
interval_unit |
A string representing the interval unit for this product, either month or day
|
P |
initial_charge_in_cents |
The up-front charge you have specified. | Q |
trial_price_in_cents |
The price of the trial period for a subscription to this product, in integer cents. | R |
trial_interval |
A numerical interval for the length of the trial period of a subscription to this product. See the description of interval for a description of how this value is coupled with an interval unit to calculate the full interval |
S |
trial_interval_unit |
A string representing the trial interval unit for this product, either month or day
|
T |
archived_at |
Timestamp indicating when this product was archived | U |
require_credit_card? |
true/false: has a credit card been requested? | V |
request_credit_card? |
true/false: has a credit card been requested? | W |
return_params |
Additional return parameters that will be added to the end of the return URL | X |
request_shipping_address? |
true/false: has the shipping address been requested? | Y |
require_shipping_address? |
true/false: is the shipping address been required? | Z |
request_billing_address? |
true/false: has the billing address been requested? | AA |
require_billing_address? |
true/false: is the billing address been required? | AB |
update_return_params |
The parameters we will append to your update_return_url | AC |
default_product_price_point_id |
The id of the default price point to be used | AD |
Tax History Fields - Avalara
Use the following table to refer to the values provided from an export of tax history if you have Avalara enabled. Tax data will appear in the month that it is applied.
| Field | Description | Column |
|---|---|---|
id |
The unique identifier for the taxation charge | A |
taxation_id |
ID of the tax | B |
transaction_id |
ID of the transaction | C |
statement_id |
ID of the statement in Advanced Billing | D |
subscription_id |
ID of the subscription in Advanced Billing | E |
site_id |
ID of the site in Advanced Billing | F |
rate_when_recorded |
Rate of tax when the tax was applied | G |
taxable_amount_in_cents |
Taxable amount in cents | H |
tax_amount_in_cents |
Amount of tax in cents charged based off the taxable amount | I |
description |
Description of the tax applied | J |
jurisdiction_name |
Name of jurisdiction applying tax | K |
jurisdiction_type |
Type of jurisdiction applying tax | L |
subdivision_code |
Subdivision under jurisdiction_type that has applied the tax |
M |
country_code |
Country code of applied tax | N |
recorded_at |
Timestamp of the date the tax was recorded in Advanced Billing | O |
created_at |
Timestamp of the date the tax transaction was created in Advanced Billing | P |
updated_at |
Timestamp of the date the subscription was updated at in Advanced Billing | Q |
collected_at |
Timestamp of the date the tax was collected in Advanced Billing | R |
Tax History Fields - Custom Taxes
Use the following table to refer to the values provided from an export of tax history if you have custom taxes enabled. Tax data will appear in the month that it is applied.
| Field | Description | Column |
|---|---|---|
id |
The unique identifier for the taxation charge | A |
created_at |
ID of the tax | B |
type |
ID of the transaction | C |
memo |
Memo regarding the transaction | D |
amount_in_cents |
Amount in cents of the charge | E |
ending_balance_in_cents |
Ending balance of the current collected revenue | F |
subscription_id |
Subscription ID in Advanced Billing | G |
customer_id |
Customer ID in Advanced Billing | H |
customer_name |
Customer first and last name | I |
product_id |
Product ID that the taxation was applied to | J |
success |
Was the payment for the charge successful? | K |
kind |
Type of transaction | L |
payment_id |
ID of the payment | M |
gateway_transaction_id |
Transaction ID generated by the gateway | N |
customer_organization |
Customer organization | O |
gateway_order_id |
Gateway order ID (if applicable) | P |
Component Export
Component Fields
| Field | Description | Column |
|---|---|---|
id |
The component ID | A |
name |
The component name | B |
handle |
The component API handle | C |
description |
The component description | D |
accounting_code |
The product family accounting code (has no bearing in Advanced Billing, may be used within your app) | E |
event_based_billing_metric_id |
Identifier for event-based billing metrics associated with the component. (Only applicable if utilizing event-based billing | F |
product_family_id |
ID of product family within Advanced Billing | G |
product_family_handle |
A custom handle or code used to identify the product family. | H |
created_at |
Timestamp of the creation of the product | I |
default_price_point_id |
The id of the default price point to be used. | J |
default_price_point_handle |
The custom handle of the default price point to be used. | K |
default_price_point_pricing_scheme |
The pricing scheme (e.g., per unit) for the default price point. | L |
unit_price_# |
The price per unit for components with 'per_unit' pricing schemes (may be null for others). | M |
default_price_point_interval_# |
The default billing interval matching the component export. | N |
default_price_point_interval_unit_# |
The default unit of the billing interval matching the component export. | O |
archived_at |
Timestamp indicating when this component was archived | P |
taxable |
Indicates whether the component is taxable. | Q |
tax_code |
The tax code associated with the component. | R |
recurring |
Indicates whether the component is part of a recurring subscription. | S |
item_kind |
The kind or type of the component. | T |
item_category |
The category to which the component belongs. | U |
allow_fractional_quantities |
Specifies whether fractional quantities are allowed for this component. | V |
use_site_exchange_rate |
Indicates whether the site's exchange rate is applied to this component. | W |
unit_name |
The name of the unit used for measurement (e.g., "item," "hour"). | X |
downgrade_credit |
Credit applied when downgrading from this component. | Y |
upgrade_credit |
Additional charge applied when upgrading to this component. | Z |
Cross Site Exports
Users who have owner or admin permissions can access an exports page from the merchant dashboard. This page allows select exports to be generated across all sites into one consolidated CSV.
Merchant Dashboard Exports
Below are the current supported cross-site exports:
- Subscriptions Export
- Sales Commissions
If there are additional exports that you would like to generate across all sites, please let us know.
Cross Site MRR And Usage Movements Fields
| Field | Description | Column |
|---|---|---|
timestamp |
Timestamp indicating when the MRR event occurred | A |
category |
The type of the MRR event: new_business, expansion, reactivation, contraction, churn
|
B |
mrr_movement |
The growth (either positive or negative) using the site’s currency | C |
mrr_movement_in_seller_currency |
The growth (either positive or negative) using the seller’s currency | D |
description |
An English explanation of the MRR event. For example, “Delores Quigley increased Widgets to 64 (+47).” | E |
subscription_id |
The unique identifier for the Subscription | F |
subscriber_name |
The name of the subscriber | G |
subscription_url |
Direct URL to the Subscription | H |
type |
Describes the revenue type - either recurring or usage revenue |
I |
reason_code |
The Churn Reason Code | J |
site_id |
The unique identifier for the Site | K |
site_subdomain |
The Site subdomain name | L |
currency |
The currency code for the Site | M |
currency_symbol |
The currency symbol for the Site | N |
seller_currency |
The currency code for the Seller | O |
seller_currency_symbol |
The currency symbol for the Seller | P |
Sales Commission Fields
The trailing 12 columns of the Sales Commission Export will contain the current and past 6 months of subscription MRR and usage (metered) revenue.
| Field | Description | Column |
|---|---|---|
subscription_id |
The ID for the subscription | A |
subscription_created_at |
Timestamp for when the subscription was created | B |
customer_id |
The ID of the customer associated with the subscription | C |
customer_name |
The name of the customer associated with the subscription | D |
product_id |
The ID of the current product for the subscription | E |
site_id |
The ID of the site | F |
site_subdomain |
The subdomain of the site | G |
first_billing_at |
The timestamp of the subscription’s first billing | H |
last_billing_at |
The timestamp of the subscription’s latest billing | I |
first_payment_at |
The timestamp of the subscription’s first payment | J |
last_payment_at |
The timestamp of the subscription’s latest payment | K |
in_dunning |
Indicates whether or not the subscription is past due | L |
churned_at |
The timestamp for when the subscription canceled or revenue dropped to $0 | M |
days_to_churned_at |
Number of days between subscription created at and churned at | N |
sales_rep |
The sales rep associated with the subscription | O |
number_of_payments |
The number of payments | P |
jan_2019_usage |
The subscription’s month usage value | Q |
jan_2019_mrr |
The subscription’s monthly recurring revenue value | R |
Comments
Article is closed for comments.