Preview

reserveInvoiceBalance is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

reserveInvoiceBalance

Reserve an invoice balance

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:

    Scopes

    billing.invoice.reserve.instance

    Arguments

    input ReserveInvoiceBalanceInput! PREVIEW

    ReserveInvoiceBalanceInput fields

    invoiceId ID!

    UUID of the invoice to reserve

    Return Fields

    invoice Invoice PREVIEW

    The invoice with the reserved balance

    operationStatus BalanceOperationStatus PREVIEW

    Status of the operation, either SUCCEEDED or FAILED

    userErrors [ReserveInvoiceBalanceError!] PREVIEW

    User errors in the reserve invoice balance request

    Interactive example

    This is an example mutation query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.