v13

latestOpenAPI 3.0.32026-07-31359869.4 MB
marketplace

Submit Invoice

This endpoint allows the partner to submit an invoice to Vercel. The invoice is created in Vercel's billing system and sent to the customer. Depending on the type of billing plan, the invoice can be sent at a time of signup, at the start of the billing period, or at the end of the billing period.<br/> <br/> Use the credentials.access_token we provided in the Upsert Installation body to authorize this request. <br/> There are several limitations to the invoice submission:<br/> <br/> 1. A resource can only be billed once per the billing period and the billing plan.<br/> 2. The billing plan used to bill the resource must have been active for this resource during the billing period.<br/> 3. The billing plan used must be a subscription plan.<br/> 4. The interim usage data must be sent hourly for all types of subscriptions. See Send subscription billing and usage data API on how to send interim billing and usage data.<br/> 5. If provided, externalId must be unique for the installation.<br/>

post/v1/installations/{integrationConfigurationId}/billing/invoices

Path parameters

integrationConfigurationIdstring required

Request body

externalIdstring

Partner-provided invoice identifier. If provided, it must be unique for this installation.

invoiceDatestring date-time required

Invoice date. Must be within the period's start and end.

memostring

Additional memo for the invoice.

finalboolean

Set this to true if this is the final invoice for the installation. Can only be set when the installation is pending deletion.

Response

invoiceIdstring
testfalse | true
validationErrorsstring[]