> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.tabs.com/api-reference/renewals/integrators-api-renewals-controller-execute-renewal/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.tabs.com/_mcp/server.

# Execute a renewal

POST https://integrators.prod.api.tabsplatform.com/v3/renewals/{id}/execute
Content-Type: application/json

Starts executing the renewal asynchronously: the excluded billing terms are removed from the draft renewal contract, the draft is marked processed, and the renewal becomes `APPROVED`. Poll `GET /v3/renewals/:id` until the status is `APPROVED`. The renewal must be `DRAFT` and have a draft renewal contract (approve the contract to generate one). Repeat calls start only one workflow.

Reference: https://docs.tabs.com/api-reference/renewals/integrators-api-renewals-controller-execute-renewal

## Authentication

- `Authorization` header (required) — API Key authentication via header

## Request

### Path parameters

- `id` (string, required) — Renewal Id

### Body (application/json)

This endpoint expects an ExecuteRenewalDto.

- `excludedBillingTermIds` (list of string, optional) — Billing term ids on the draft renewal contract to leave out of the renewal. Ids not on the current draft are ignored.

## Response

### 202

The execute workflow was started

- `payload` (ExecuteRenewalResponseDto, required) — Response payload, will be empty when success is false
- `success` (boolean, required) — Boolean with true=success, false=failure
- `message` (string, required) — Plain-text description of the result
- `error` (IntegratorsApiError, optional) — json element with any error messages or warnings

## Errors

### 400 Bad Request Error

Invalid body, the renewal is not `DRAFT`, or it has no draft contract

- `any`

### 404 Not Found Error

No such renewal under your merchant account, or renewals are not enabled for your merchant account

- `any`

## Types

### ExecuteRenewalResponseDto

- `eventId` (string, required) — Outbox event id for the execute workflow
- `workflowId` (string, required) — Workflow id; repeat calls for the same draft return the same one

### IntegratorsApiError

- `code` (double, required) — API response code
- `message` (string, required) — API response message
- `details` (IntegratorsApiErrorDetails, optional) — Additional details about the error

### IntegratorsApiErrorDetails

Additional details about the error

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "payload": {
    "eventId": "string",
    "workflowId": "string"
  },
  "success": true,
  "message": "string",
  "error": {
    "code": 1.1,
    "message": "string",
    "details": {}
  }
}
```

**SDK Code**

```python
import requests

url = "https://integrators.prod.api.tabsplatform.com/v3/renewals/123e4567-e89b-12d3-a456-426614174000/execute"

payload = {}
headers = {
    "Authorization": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://integrators.prod.api.tabsplatform.com/v3/renewals/123e4567-e89b-12d3-a456-426614174000/execute';
const options = {
  method: 'POST',
  headers: {Authorization: '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://integrators.prod.api.tabsplatform.com/v3/renewals/123e4567-e89b-12d3-a456-426614174000/execute"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://integrators.prod.api.tabsplatform.com/v3/renewals/123e4567-e89b-12d3-a456-426614174000/execute")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://integrators.prod.api.tabsplatform.com/v3/renewals/123e4567-e89b-12d3-a456-426614174000/execute")
  .header("Authorization", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://integrators.prod.api.tabsplatform.com/v3/renewals/123e4567-e89b-12d3-a456-426614174000/execute', [
  'body' => '{}',
  'headers' => [
    'Authorization' => '<apiKey>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://integrators.prod.api.tabsplatform.com/v3/renewals/123e4567-e89b-12d3-a456-426614174000/execute");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://integrators.prod.api.tabsplatform.com/v3/renewals/123e4567-e89b-12d3-a456-426614174000/execute")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```