v1

latestOpenAPI 3.1.02026-08-042453938.9 KB
Invoices

Generate invoice from subscription

Generate an invoice for a subscription billing period. Supports prorated amounts for partial periods (mid-cycle starts, cancellations, upgrades/downgrades). Optionally includes usage charges from the same period.

The invoice is created in DRAFT status. Use the issue endpoint to finalize it.

post/v1/invoices/generate-from-subscription

Request body

customerIdstring required

Customer ID

subscriptionIdstring required

Subscription ID

periodStartstring date-time

Override period start (ISO 8601)

periodEndstring date-time

Override period end (ISO 8601)

dueDatestring date-time

Payment due date (ISO 8601)

notesstring
customerNotesstring
includeUsageChargesboolean

Bundle usage charges in the same invoice

Response

Invoice generated

object required

Invoice generated