> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.beehiiv.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.beehiiv.com/_mcp/server.

# Pause paid recommendation partnership <Badge intent="info" minimal outlined>OAuth Scope: posts:write</Badge>

POST https://api.beehiiv.com/v2/publications/{publicationId}/paid_recommendations/partnerships/{partnershipId}/pause

This feature is currently in beta and the API is subject to change.

Pause an active partnership. The publication stops recommending you until you resume it.

Reference: https://developers.beehiiv.com/api-reference/paid-recommendations-partnerships/pause

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `publicationId` (string, required) — The prefixed ID of the publication object
- `partnershipId` (string, required) — The prefixed ID of the partnership object

## Response

### 200

OK

- `data` (PaidRecommendationPartnership, required)

## Errors

### 400 Bad Request Error

Bad Request

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 401 Unauthorized Error

Unauthorized. The API key or OAuth access token is missing, invalid, or expired.

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 403 Forbidden Error

Forbidden

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 404 Not Found Error

Resource Not Found

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 422 Unprocessable Entity Error

Unprocessable Entity

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 429 Too Many Requests Error

Rate Limit Exceeded

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 500 Internal Server Error

Internal Server Error

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

## Types

### PaidRecommendationPartnership

- `accepted_subscribers` (integer, required) — Subscribers that passed verification and were paid for.
- `auto_accepted` (boolean, required) — Whether the application was accepted automatically by the offer's auto-accept settings.
- `created_at` (integer, required) — The time the application was submitted. Measured in seconds since the Unix epoch.
- `id` (string, required) — The prefixed ID of the application or partnership.
- `offer` (PaidRecommendationAgreementOffer, required) — The offer the recommending publication applied to.
- `pending_spend_cents` (integer, required) — The amount in cents reserved for pending subscribers.
- `pending_subscribers` (integer, required) — Subscribers waiting for verification.
- `recommending_publication` (PaidRecommendationAgreementPublication, required) — The publication that recommends you.
- `status` (enum, required) — The current status of the partnership.
  - Allowed values: `active`, `paused`, `inactive`, `frozen`, `archived`
- `total_spend_cents` (integer, required) — The amount in cents spent on accepted subscribers.
- `total_subscribers` (integer, required) — All subscribers the recommending publication has sent you, in any verification state.
- `updated_at` (integer, required) — The time the record was last updated. Measured in seconds since the Unix epoch.
- `rejected_reason` (string, optional) — The reason given when the application was rejected. The applicant sees this reason.

### ErrorDetail

- `message` (string, required)
- `code` (string, required)

### PaidRecommendationAgreementOffer

- `id` (string, required) — The prefixed ID of the offer.
- `name` (string, required) — The name of the offer.

### PaidRecommendationAgreementPublication

- `id` (string, required) — The prefixed ID of the recommending publication.
- `name` (string, required) — The name of the recommending publication.
- `url` (string, required) — The URL of the recommending publication's website.

## Examples

**Response**

```json
{
  "data": {
    "accepted_subscribers": 100,
    "auto_accepted": false,
    "created_at": 1767225600,
    "id": "rec_agr_00000000-0000-0000-0000-000000000000",
    "offer": {
      "id": "rec_offer_00000000-0000-0000-0000-000000000000",
      "name": "Spring growth offer"
    },
    "pending_spend_cents": 3750,
    "pending_subscribers": 15,
    "recommending_publication": {
      "id": "pub_00000000-0000-0000-0000-000000000001",
      "name": "The Morning Brief",
      "url": "https://morningbrief.beehiiv.com/"
    },
    "status": "paused",
    "total_spend_cents": 25000,
    "total_subscribers": 120,
    "updated_at": 1767312000,
    "rejected_reason": null
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/paid_recommendations/partnerships/rec_agr_00000000-0000-0000-0000-000000000000/pause"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/paid_recommendations/partnerships/rec_agr_00000000-0000-0000-0000-000000000000/pause';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/paid_recommendations/partnerships/rec_agr_00000000-0000-0000-0000-000000000000/pause"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/paid_recommendations/partnerships/rec_agr_00000000-0000-0000-0000-000000000000/pause")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/paid_recommendations/partnerships/rec_agr_00000000-0000-0000-0000-000000000000/pause")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/paid_recommendations/partnerships/rec_agr_00000000-0000-0000-0000-000000000000/pause', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/paid_recommendations/partnerships/rec_agr_00000000-0000-0000-0000-000000000000/pause");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/paid_recommendations/partnerships/rec_agr_00000000-0000-0000-0000-000000000000/pause")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

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()
```