div[id^="schema-"] + div > div:has(> span),
#content-area > #header + div > div.mt-6.flex.w-full.flex-col.space-y-4 {
    display: none;
}

/* In content-area, hide the Response's attributes */
#content-area div:has(> div[id^="response-"]) {
    display: none;
}

/* In content-area, hide the little status-code badge (e.g. "200")
   that sits in the header row of the Response section */
#content-area .flex.items-baseline.border-b .font-mono.text-xs > .relative:first-child {
    display: none;
}

/*
In content-area, hide the human-readable status sentence shown
   just below the "Response" heading (e.g. "Driver successfully created.")
#content-area .text-sm.prose.prose-gray.dark\:prose-invert.mb-2 {
    display: none;
}
*/

/* In content-area, hide any empty sections such as orphaned "Body" blocks */
#content-area *:has(> *:only-child > * > h4) {
    display: none;
}

/* Reduce the padding Y of the Attributes */
#content-area div:has(> :is([id^="schema-"], [id^="body-"], [id^="parameter-"])) {
    padding: 1.2rem 0;
}

/* Reduce the gap between Attributes' children */
#content-area div:has(> :is([id^="schema-"], [id^="body-"], [id^="parameter-"])) > :last-child {
    margin-top: 0.5rem;
}

/* Reduce the gap of Attributes requirement */
#content-area
    div:has(> :is([id^="schema-"], [id^="body-"], [id^="parameter-"]))
    > :last-child
    > :nth-child(2) {
    margin-top: 1rem;
}

#content-area div.relative.mt-8.prose.prose-gray > div > div.pt-6.pb-4 {
    display: none;
}

#content-area > #header + div > div.mt-6.flex.w-full.flex-col.space-y-4 + div {
    margin-top: 2rem;
}

#navigation-items a.group > span {
    display: none;
}

#navigation-items div > svg[style*="pen-paintbrush.svg"] {
    display: none;
}

#navigation-items > div svg:only-of-type {
    display: none;
}

#navigation-items div:hover,
#navigation-items a:not(.bg-primary\/10):hover {
    background-color: transparent;
}

#navigation-items div:has(> svg[style*="pen-paintbrush.svg"]) {
    font-weight: bold;
    justify-content: space-between;
}

div[id="headlessui-dialog-overlay-:r1:"] + div {
    padding-left: 1rem;
    padding-right: 1rem;
}

@media (min-width: 1024px) {
    #navbar + div,
    #navbar-transition + div {
        max-width: none;
        padding-left: 0;
        padding-right: min(6.1rem, calc(-1.7rem + 5vw));
    }

    #navbar-transition + div > div > div > div {
        padding-left: 2rem;
        padding-right: 0;
    }

    #content-area {
        padding-left: min(calc(23.7rem + 6.1rem), calc(22rem + 5vw));
    }

    #sidebar {
        margin-left: 1rem;
        top: 0 !important;
        border-right: rgb(216, 222, 228) 1px solid;
    }

    .dark #sidebar {
        border-right: rgb(31, 32, 33) 1px solid;
    }

    #sidebar-content {
        top: 4rem;
        padding-bottom: 1rem;
        padding-right: 0;
    }
}


{
    // Implements single-open accordion behavior
    function initAccordion(navRoot) {
        if (navRoot._accordionInitialized) return
        navRoot._accordionInitialized = true

        const onClick = (event) => {
            if (!event.isTrusted) return
            const group = event.target.closest(".group")
            if (!group || event.target.closest("a")) return

            const submenu = group.nextElementSibling
            if (!submenu || submenu.tagName !== "UL" || !submenu.querySelector(":scope > li > a")) {
                return
            }
            const isOpen = submenu.matches(":not([hidden])")
            if (!isOpen) {
                navRoot.querySelectorAll(".group + ul").forEach((otherUl) => {
                    if (otherUl !== submenu && otherUl.querySelector(":scope > li > a")) {
                        otherUl.previousElementSibling.dispatchEvent(
                            new MouseEvent("click", { bubbles: true })
                        )
                    }
                })
            }
        }

        const observer = new MutationObserver((mutations) => {
            for (const { addedNodes } of mutations) {
                for (const node of addedNodes) {
                    if (
                        node.nodeType === Node.ELEMENT_NODE &&
                        node.tagName === "UL" &&
                        node.querySelector(":scope > li > a")
                    ) {
                        navRoot.querySelectorAll(".group + ul").forEach((otherUl) => {
                            if (otherUl !== node && otherUl.querySelector(":scope > li > a")) {
                                otherUl.previousElementSibling.dispatchEvent(
                                    new MouseEvent("click", { bubbles: true })
                                )
                            }
                        })
                    }
                }
            }
        })

        navRoot.addEventListener("click", onClick, { capture: true })
        observer.observe(navRoot, { childList: true, subtree: true })
        navRoot._accordionObserver = observer
    }

    const existing = document.getElementById("navigation-items")
    if (existing) initAccordion(existing)

    new MutationObserver((mutations) => {
        for (const { addedNodes } of mutations) {
            for (const node of addedNodes) {
                if (node.nodeType !== Node.ELEMENT_NODE) continue
                const sidebar =
                    node.id === "navigation-items"
                        ? node
                        : node.querySelector?.("#navigation-items")

                if (sidebar) initAccordion(sidebar)
            }
        }
    }).observe(document.body, {
        childList: true,
        subtree: true,
    })
}


{
    // Shows a temporary banner when custom scripts are loaded (dev mode only)
    function banner() {
        const devHosts = ["localhost", "127.0.0.1"]
        if (!devHosts.includes(window.location.hostname)) return

        const tag = document.createElement("div")
        tag.textContent = "✔️ Custom JS is active"
        Object.assign(tag.style, {
            position: "fixed",
            bottom: "1rem",
            right: "1rem",
            background: "#10b981",
            color: "white",
            padding: "0.5rem 1rem",
            borderRadius: "0.5rem",
            fontSize: "0.875rem",
            zIndex: "9999",
            boxShadow: "0 0 6px rgba(0,0,0,0.2)",
        })
        document.body.appendChild(tag)
        setTimeout(() => tag.remove(), 4000)
    }

    banner()
}


{
    function hidePathParams() {
        const contentArea = document.getElementById("content-area")
        if (!contentArea) return

        contentArea.querySelectorAll("h4").forEach((h4) => {
            if (h4.textContent.trim() === "Path Parameters") {
                let el = h4
                for (let i = 0; i < 3 && el; i++) el = el.parentElement
                if (el) el.style.display = "none"
            }
        })
    }

    hidePathParams()

    const container = document.getElementById("content-container")
    if (container) {
        new MutationObserver((mutations) => {
            for (const m of mutations) {
                if (m.type === "childList" && (m.addedNodes.length || m.removedNodes.length)) {
                    hidePathParams()
                    break
                }
            }
        }).observe(container, {
            childList: true,
            subtree: true,
        })
    }
}


{
    function changeResponseCode() {
        const container = document.getElementById("content-container")
        const secondGroups = container?.querySelectorAll(
            "#content-side-layout .code-group:nth-of-type(2)"
        )

        secondGroups.forEach((secondGroup) => {
            const tablist = secondGroup.querySelector('[role="tablist"]')
            const buttons = tablist?.querySelectorAll("button")
            const firstBtn = buttons?.[0]
            if (!firstBtn || firstBtn.tagName === "DIV") return

            firstBtn.dispatchEvent(new MouseEvent("click", { bubbles: true }))

            const label = firstBtn.firstElementChild // unique div
            if (!label || label.textContent.trim() === "Response") return
            ;[...buttons].slice(1).forEach((button) => button.remove())

            const span = document.createElement("span")
            span.className = label.className
                .split(/\s+/)
                .filter((classe) => !classe.includes("hover"))
                .join(" ")
            span.textContent = "Response"

            label.replaceWith(span)

            const div = document.createElement("div")
            div.className = firstBtn.className
            div.style.cssText = firstBtn.style.cssText

            while (firstBtn.firstChild) {
                div.appendChild(firstBtn.firstChild)
            }

            firstBtn.replaceWith(div)
        })
    }

    changeResponseCode()

    const container = document.getElementById("content-container")
    if (container) {
        new MutationObserver((mutations) => {
            for (const m of mutations) {
                if (m.type === "childList" && (m.addedNodes.length || m.removedNodes.length)) {
                    changeResponseCode()
                    break
                }
            }
        }).observe(container, {
            childList: true,
            subtree: true,
        })
    }
}


{
    // Opens paintbrush SVG menu
    document.querySelectorAll("#navigation-items div > svg").forEach((svg) => {
        const styleAttr = svg.getAttribute("style") || ""
        if (styleAttr.includes("pen-paintbrush.svg")) {
            svg.parentElement.click()
        }
    })
}


{
    // Updates the code-group tab label (Example) to match the title of the page
    function refresh() {
        if (!location.href.toLowerCase().includes("object")) return
        const titlePageElement = document.getElementById("page-title")
        const titlePage = titlePageElement?.textContent
        if (!titlePage) return

        const container = document.getElementById("content-container")
        const lastGroup = container?.querySelector(
            "#content-container .code-group:last-of-type"
        )

        const tablist = lastGroup.querySelector('[role="tablist"]')
        const buttons = tablist?.querySelectorAll("button")
        const firstBtn = buttons?.[0]
        if (!firstBtn || firstBtn.tagName === "DIV") return

        const label = firstBtn.firstElementChild
        if (!label || label.textContent.trim() === titlePage) return
        ;[...buttons].slice(1).forEach((button) => button.remove())

        const span = document.createElement("span")
        span.className = label.className
            .split(/\s+/)
            .filter((classe) => !classe.includes("hover"))
            .join(" ")
        span.textContent = titlePage

        label.replaceWith(span)

        const div = document.createElement("div")
        div.className = firstBtn.className
        div.style.cssText = firstBtn.style.cssText

        while (firstBtn.firstChild) {
            div.appendChild(firstBtn.firstChild)
        }

        firstBtn.replaceWith(div)
    }

    refresh()

    window.addEventListener("popstate", () => setTimeout(refresh, 0))
    ;["pushState", "replaceState"].forEach((name) => {
        const orig = history[name]
        history[name] = function (...args) {
            const res = orig.apply(this, args)
            setTimeout(refresh, 0)
            return res
        }
    })

    new MutationObserver((records) => {
        for (const rec of records) {
            if (rec.type === "childList") {
                for (const node of rec.addedNodes) {
                    if (
                        node.nodeType === 1 &&
                        (node.id === "code-group" || node.querySelector?.("#code-group"))
                    ) {
                        return refresh()
                    }
                }
            }
            if (rec.type === "characterData" && rec.target.parentElement?.id === "page-title") {
                return refresh()
            }
        }
    }).observe(document.body, {
        childList: true,
        subtree: true,
    })
}


Locks the invoice’s line items, calculates taxes and totals, and changes `status` from `draft` to `open`, making the invoice ready for payment.


Finalize an invoice

Returns the Invoice object with status updated to open, line-items locked, and amount_due computed. Raises an error if the invoice is already finalized, void, or paid.

Unable to finalize (for example, invoice already finalized or void).

Standard error wrapper returned by the Charge API when a request fails. The `type` field classifies the error category, while `code` and `message` provide a stable programmatic identifier and a human-readable explanation you can surface to end-users.


Charge

Welcome to the home of your new documentation

Getting Started

Path Parameters

Body

Response