For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
LoginSandbox
Platform GuidesAPI DocsSDKMCP ServerChangelog
Platform GuidesAPI DocsSDKMCP ServerChangelog
  • Getting started
    • Introduction
    • Concepts
    • Onboarding guide
  • Use cases
    • Monetizing an AI agent
    • Pricing models for AI products
    • Configuring entitlements for AI products
  • Usage metering & events
    • Meters
    • Usage events
    • Unmatched events
    • Event reprocessing
  • Products & plans
    • Product Catalog
    • Pricing Plans
    • Features & Entitlements
  • Wallets & credits
    • Credit types & wallets
    • Credits in pricing plans
  • Customers & subscriptions
    • Customers
    • Subscriptions
    • Quotes
  • Invoicing
    • Invoices
    • Invoice corrections
    • Payment Collections
    • Tax
    • Currencies & Exchange rates
    • E-invoicing
  • Analytics & reporting
    • Insights
    • Report downloads
    • Revenue Recognition & Deferred Revenue
  • Integrations
    • CRM
    • ERP
    • Email Providers
    • Data Imports: Event File Uploads
    • Data Exports
    • Payment Service Providers
  • Settings & admin
    • Billing entities
    • Payment Options
    • User management
    • Customising invoices
    • Custom fields
    • Default platform settings
    • API key creation
    • Alert Rules
    • Workflows
  • Workflows
    • Workflow Triggers
    • Workflow Actions
    • Monitoring and Audit
    • Common Use Cases
  • For developers
    • Introduction
    • Authentication
    • Local development setup
    • API
    • Errors
    • Troubleshooting
    • Query Parameters
    • Expanding Responses
    • Idempotency
    • Timestamp formatting
    • Webhooks
    • Locale
    • MCP Server
LoginSandbox
For developers

Expanding Responses

Many objects allow you to request additional information as an expanded response by using the expand request parameter. This parameter is available on all API requests and applies to the response of that request only. Responses can be expanded in two ways.

In many cases, an object contains the ID of a related object in its response properties. For example, an Invoice may have an associated Customer ID. Those objects can be expanded in line with the expand request parameter. ID fields that can be expanded into objects are noted in this documentation with the expandable label.

Not all resources can be expanded (yet). Do you have a need for a resource to be expanded in one of our APIs? Don’t hesitate to contact our team and let us know.


Was this page helpful?
Previous

Idempotency

Next
Built with