Subscription Settlement

Use this page to retrieve a settlement-oriented reporting object for a subscription or order context.

Who This Is For

• operators reviewing subscription or order-linked usage and settlement inputs
• finance-adjacent teams that need a reporting summary rather than raw billing logic
• developers exposing settlement summaries in internal tools

When To Use This

Use subscription settlement when the reporting question is tied to a subscription or order and you want a commercial summary object rather than raw activity rows.

How It Works

GET /api/v1/reports/subscription-settlement uses report:read.

Important query parameters:

• subscription_id
• order_id
• from
• to
• group_by
• limit

Response shape:

• data: a settlement summary object
• meta

This reporting surface is not a billing engine. It is a reporting and export layer over stored evidence and linked commerce records.

Example

curl "https://api.licensekit.dev/api/v1/reports/subscription-settlement?subscription_id=sub_123&group_by=license_id" \
  -H "Authorization: Bearer $LICENSEKIT_TOKEN"

Common Mistakes

• treating the settlement route as an invoicing engine
• assuming orders and subscriptions carry provider-specific proration semantics
• expecting this route to replace the underlying order and subscription management records

Related Pages

• Orders And Subscriptions
• Reporting Exports
• Customer Summary