Skip to content

Latest commit

 

History

History
50 lines (45 loc) · 7.69 KB

getinvoiceresponsebody.md

File metadata and controls

50 lines (45 loc) · 7.69 KB

GetInvoiceResponseBody

Example Usage

import { GetInvoiceResponseBody } from "@vercel/sdk/models/getinvoiceop.js";

let value: GetInvoiceResponseBody = {
  invoiceId: "<id>",
  state: "refunded",
  invoiceDate: "<value>",
  period: {
    start: "<value>",
    end: "<value>",
  },
  items: [
    {
      billingPlanId: "<id>",
      name: "<value>",
      price: "156.69",
      quantity: 2736.38,
      units: "<value>",
      total: "<value>",
    },
  ],
  total: "<value>",
  created: "<value>",
  updated: "<value>",
};

Fields

Field Type Required Description
test boolean ➖ Whether the invoice is in the testmode (no real transaction created).
invoiceId string ✔️ Vercel Marketplace Invoice ID.
externalId string ➖ Partner-supplied Invoice ID, if applicable.
state models.State ✔️ Invoice state.
invoiceNumber string ➖ User-readable invoice number.
invoiceDate string ✔️ Invoice date. ISO 8601 timestamp.
period models.GetInvoicePeriod ✔️ Subscription period for this billing cycle. ISO 8601 timestamps.
memo string ➖ Additional memo for the invoice.
items models.GetInvoiceItems[] ✔️ Invoice items.
discounts models.GetInvoiceDiscounts[] ➖ Invoice discounts.
total string ✔️ Invoice total amount. A dollar-based decimal string.
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.
created string ✔️ System creation date. ISO 8601 timestamp.
updated string ✔️ System update date. ISO 8601 timestamp.