Header Only - API

Overview

The header_only=true parameter is an API query option used to retrieve only header-level (summary) data of a resource, excluding all nested or child-level details.

This parameter is supported across key modules such as:

• Customers
• Subscriptions
• Invoices
• Payments
• Workflow

It is primarily used to optimize performance and reduce response payload size.

Purpose

The header_only parameter enables:

• Faster API response times
• Reduced payload size
• Targeted data retrieval
• Efficient bulk data processing

How It Works

With header_only=true

• Returns:
  • Only top-level fields
• Excludes the child objects:
  • Line items
  • Child objects
  • Detailed transactional data

Supported Modules & Endpoints

Subscription API

Sample Response:

Includes

• Subscription ID
• Customer details
• Status
• Contract dates
• Currency
• Custom fields

Invoice API

Includes

• Invoice ID
• Customer details
• Invoice amount
• Status
• Dates
• Billing contact

Payment API

Includes

• Payment ID
• Customer details
• Payment amount
• Status
• Applied/unapplied amounts

Response Structure

Header-Level Fields (Included)

• ID
• Customer ID / Name
• Status
• Dates (created, updated, effective dates)
• Currency
• Summary amounts
• Custom fields

Excluded Fields

• Line items
• Pricing breakdown
• Usage data
• Nested child objects
• Detailed transaction records

Filtering & Data Retrieval

Identifier-Based Retrieval

Fetch a specific record:

Bulk Retrieval (Optimized)

• Use:
  • Filters
  • Pagination
  • header_only=true

Ensures:

• Minimal payload
• Faster execution

Conditional Data Control

• Include/exclude child attributes using:
  • true / false flags
• Combine with filters for precise queries

Sample Examples

Subscription

Invoice

Payment

For more information, see List Customer API documentation