Invoice Actions | Edgenivo SDK

APIs & SDKs

Invoice Actions

POST/__remote/api.vercel.com/v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}/actions

This endpoint allows the partner to request a refund for an invoice to Edgenivo. The invoice is created using the Submit Invoice API.

Request

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

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

async function run() {
  await vercel.marketplace.updateInvoice({
    integrationConfigurationId: "<id>",
    invoiceId: "<id>",
    requestBody: {
      action: "refund",
      reason: "<value>",
      total: "<value>",
    },
  });


}

run();

Response

{}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

integrationConfigurationIdstringRequired

invoiceIdstringRequired

Body

application/json

actionstringRequired

reasonstringRequired

Refund reason.

totalstringRequired

The total amount to be refunded. Must be less than or equal to the total amount of the invoice.

Response

204Success

Errors

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

409Error

410Error

Request

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

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

async function run() {
  await vercel.marketplace.updateInvoice({
    integrationConfigurationId: "<id>",
    invoiceId: "<id>",
    requestBody: {
      action: "refund",
      reason: "<value>",
      total: "<value>",
    },
  });


}

run();

Response

{}

OpenAPI Specification