GET
/
v1
/
installations
/
{integrationConfigurationId}
/
billing
/
invoices
/
{invoiceId}
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.marketplace.getInvoice({
    integrationConfigurationId: "<id>",
    invoiceId: "<id>",
  });

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

run();
{
  "test": true,
  "invoiceId": "<string>",
  "externalId": "<string>",
  "state": "pending",
  "invoiceNumber": "<string>",
  "invoiceDate": "<string>",
  "period": {
    "start": "<string>",
    "end": "<string>"
  },
  "memo": "<string>",
  "items": [
    {
      "billingPlanId": "<string>",
      "resourceId": "<string>",
      "start": "<string>",
      "end": "<string>",
      "name": "<string>",
      "details": "<string>",
      "price": "<string>",
      "quantity": 123,
      "units": "<string>",
      "total": "<string>"
    }
  ],
  "discounts": [
    {
      "billingPlanId": "<string>",
      "resourceId": "<string>",
      "start": "<string>",
      "end": "<string>",
      "name": "<string>",
      "details": "<string>",
      "amount": "<string>"
    }
  ],
  "total": "<string>",
  "refundReason": "<string>",
  "refundTotal": "<string>",
  "created": "<string>",
  "updated": "<string>"
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
integrationConfigurationId
string
required
​
invoiceId
string
required

Response

200
application/json
​
invoiceId
string
required

Vercel Marketplace Invoice ID.

​
state
enum<string>
required

Invoice state.

Available options:
pending,
scheduled,
invoiced,
paid,
notpaid,
refund_requested,
refunded
​
invoiceDate
string
required

Invoice date. ISO 8601 timestamp.

​
period
object
required

Subscription period for this billing cycle. ISO 8601 timestamps.

​
items
object[]
required

Invoice items.

Invoice items.

​
total
string
required

Invoice total amount. A dollar-based decimal string.

​
created
string
required

System creation date. ISO 8601 timestamp.

​
updated
string
required

System update date. ISO 8601 timestamp.

​
test
boolean

Whether the invoice is in the testmode (no real transaction created).

​
externalId
string

Partner-supplied Invoice ID, if applicable.

​
invoiceNumber
string

User-readable invoice number.

​
memo
string

Additional memo for the invoice.

​
discounts
object[]

Invoice discounts.

Invoice discounts.

​
refundReason
string

The reason for refund. Only applicable for states "refunded" or "refund_request".

​
refundTotal
string

Refund amount. Only applicable for states "refunded" or "refund_request". A dollar-based decimal string.