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.

Use the credentials.access_token we provided in the Upsert Installation body to authorize this request.
There are several limitations to the invoice submission:

1. A resource can only be billed once per the billing period and the billing plan.
2. The billing plan used to bill the resource must have been active for this resource during the billing period.
3. The billing plan used must be a subscription plan.
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.

POST

installations

{integrationConfigurationId}

billing

invoices

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.marketplace.submitInvoice({
    integrationConfigurationId: "<id>",
    requestBody: {
      invoiceDate: new Date("2023-06-05T08:54:16.353Z"),
      period: {
        start: new Date("2023-07-26T14:15:15.601Z"),
        end: new Date("2025-10-08T09:35:48.520Z"),
      },
      items: [
        {
          billingPlanId: "<id>",
          name: "<value>",
          price: "905.89",
          quantity: 1684.76,
          units: "<value>",
          total: "<value>",
        },
        {
          billingPlanId: "<id>",
          name: "<value>",
          price: "84.05",
          quantity: 9130.95,
          units: "<value>",
          total: "<value>",
        },
      ],
    },
  });

  // Handle the result
  console.log(result);
}

run();

{
  "invoiceId": "<string>",
  "test": true,
  "validationErrors": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Default authentication mechanism

Path Parameters

integrationConfigurationId

string

required

Body

application/json

invoiceDate

string

required

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

period

object

required

Subscription period for this billing cycle.

items

object[]

required

externalId

string

memo

string

Additional memo for the invoice.

discounts

object[]

test

object

Test mode

Response

200

application/json

invoiceId

string

test

boolean

validationErrors

string[]

Submit Billing Data Get Invoice

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.marketplace.submitInvoice({
    integrationConfigurationId: "<id>",
    requestBody: {
      invoiceDate: new Date("2023-06-05T08:54:16.353Z"),
      period: {
        start: new Date("2023-07-26T14:15:15.601Z"),
        end: new Date("2025-10-08T09:35:48.520Z"),
      },
      items: [
        {
          billingPlanId: "<id>",
          name: "<value>",
          price: "905.89",
          quantity: 1684.76,
          units: "<value>",
          total: "<value>",
        },
        {
          billingPlanId: "<id>",
          name: "<value>",
          price: "84.05",
          quantity: 9130.95,
          units: "<value>",
          total: "<value>",
        },
      ],
    },
  });

  // Handle the result
  console.log(result);
}

run();

{
  "invoiceId": "<string>",
  "test": true,
  "validationErrors": [
    "<string>"
  ]
}

Endpoints

Authorizations

Path Parameters

Body

Response