Skip to main content
POST
/
v1
/
exports
Create export
curl --request POST \
  --url https://api.hyperline.co/v1/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "line_by_line_revenue",
  "file_type": "csv"
}'
{
  "name": "line_by_line_revenue",
  "file_type": "csv",
  "id": "exp_YfiSnLIYORD9VN",
  "status": "processing",
  "created_at": "2025-06-03T11:32:00Z",
  "updated_at": "2025-06-07T19:13:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
enum<string>
required

Export name.

  • aged_balances: List of balances at 30, 60, and 90+ days for all customers.
  • all_customers: List of all customers.
  • outstanding_invoices: List of all outstanding invoices.
  • all_subscriptions: List of all active, pending or cancelled subscriptions.
  • revenue_per_product: Revenue per product month over month.
  • detailed_revenue: Booked revenue (outstanding and paid) split per customer and product, month over month.
  • revenue_per_line_item_name: Revenue per invoice line item month over month, grouped by name given on invoice or subscription.
  • revenue_per_country: Revenue, tax and invoice number per country.
  • revenue_per_plan: Revenue per plan month over month.
  • line_by_line_revenue: All invoice line items in chronological order, with product and customer information.
  • draft_invoices: Export all draft invoices, with customer and product information.
  • open_invoices: Export all open invoices, with customer and product information.
  • live_subscriptions: List of all active subscriptions line by line.
Available options:
aged_balances,
outstanding_invoices,
all_subscriptions,
revenue_per_product,
revenue_per_line_item_name,
revenue_per_country,
revenue_per_plan,
all_customers,
detailed_revenue,
line_by_line_revenue,
draft_invoices,
open_invoices,
live_subscriptions
Example:

"line_by_line_revenue"

​
file_type
enum<string>
required

Export file type.

  • csv: The export will be generated in CSV format.
  • xlsx: The export will be generated in XLSX format.
  • json: The export will be generated in JSON format.
Available options:
csv,
xlsx,
json
Example:

"csv"

Response

201 - application/json
​
name
enum<string>
required

Export name.

  • aged_balances: List of balances at 30, 60, and 90+ days for all customers.
  • all_customers: List of all customers.
  • outstanding_invoices: List of all outstanding invoices.
  • all_subscriptions: List of all active, pending or cancelled subscriptions.
  • revenue_per_product: Revenue per product month over month.
  • detailed_revenue: Booked revenue (outstanding and paid) split per customer and product, month over month.
  • revenue_per_line_item_name: Revenue per invoice line item month over month, grouped by name given on invoice or subscription.
  • revenue_per_country: Revenue, tax and invoice number per country.
  • revenue_per_plan: Revenue per plan month over month.
  • line_by_line_revenue: All invoice line items in chronological order, with product and customer information.
  • draft_invoices: Export all draft invoices, with customer and product information.
  • open_invoices: Export all open invoices, with customer and product information.
  • live_subscriptions: List of all active subscriptions line by line.
Available options:
aged_balances,
outstanding_invoices,
all_subscriptions,
revenue_per_product,
revenue_per_line_item_name,
revenue_per_country,
revenue_per_plan,
all_customers,
detailed_revenue,
line_by_line_revenue,
draft_invoices,
open_invoices,
live_subscriptions
Example:

"line_by_line_revenue"

​
file_type
enum<string>
required

Export file type.

  • csv: The export will be generated in CSV format.
  • xlsx: The export will be generated in XLSX format.
  • json: The export will be generated in JSON format.
Available options:
csv,
xlsx,
json
Example:

"csv"

​
id
string
required

Export ID.

Example:

"exp_YfiSnLIYORD9VN"

​
status
enum<string>
required

Export status.

  • pending: The export is pending and has not started processing yet.
  • processing: The export is currently being generated.
  • done: The export has been successfully generated.
  • errored: An error occurred during the export generation.
Available options:
pending,
processing,
done,
errored
Example:

"processing"

​
created_at
string | null
required

Export creation date. UTC date time string in the ISO 8601 format.

Example:

"2025-06-03T11:32:00Z"

​
updated_at
string | null
required

Export last edition date. UTC date time string in the ISO 8601 format.

Example:

"2025-06-07T19:13:00Z"