Invoice Actions | Vercel API

APIs & SDKs

Invoice Actions

POSThttps://api.vercel.com/v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}/actions

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

https://api.vercel.com/v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}/actions

const response = await fetch('https://api.vercel.com/v1/installations/integrationConfigurationId/billing/invoices/invoiceId/actions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "action": "refund",
    "reason": "Customer requested refund",
    "total": "100.00"
  }),
});

const data = await response.json();
console.log(data);

Response

{}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

integrationConfigurationIdstringRequired

invoiceIdstringRequired

Request

This endpoint expects an object.

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

Related Vercel documentation

This page is not in the current cross-link map.

https://api.vercel.com/v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}/actions

const response = await fetch('https://api.vercel.com/v1/installations/integrationConfigurationId/billing/invoices/invoiceId/actions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "action": "refund",
    "reason": "Customer requested refund",
    "total": "100.00"
  }),
});

const data = await response.json();
console.log(data);

Response

{}

OpenAPI Specification