Transaction APIInvoices

Create a preview invoice

Requires the INVOICE.PREVIEW permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1
version

Headers

x-platform-idstringOptional
Platform ID.

Request

This endpoint expects an object.
pricing_plan_subscription_idstringRequired
start_atdatetimeRequired
If not set, uses 'now' as start date
invoices_per_scheduleintegerRequired
Number of preview invoices to generate per schedule
template_pricing_plan_subscription_idstringRequiredDeprecated
customer_detailsobjectOptional
pricing_plan_schedule_customizationslist of objects or nullOptional
enabled_pricingslist of objects or nullOptionalDeprecated

Response

OK
invoiceobject
first_invoiceobject
invoice_infoslist of objects or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error