> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# PauseProgram

# Package: benefitPrograms

# Namespace: ProgramService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/programs/pause-program.md

## Permission Scopes:
Manage benefit programs: SCOPE.BENEFIT_PROGRAMS.MANAGE

## Introduction

Pauses the specified program. Benefits in the program's pools can't be redeemed until the program is resumed.

---

## REST API

### Schema

```
 Method: pauseProgram
 Description: Pauses the specified program. Benefits in the program's pools can't be redeemed until the program is resumed.
 URL: https://www.wixapis.com/benefit-programs/v1/programs/pause
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  programId, idempotencyKey
 Method parameters: 
   param name: idempotencyKey | type: idempotencyKey | description: Idempotency key to ensure that the request is processed only once. | required: true
   param name: programId | type: programId | description: GUID of the program to pause. | required: true
 Return type: PauseProgramResponse
  - name: jobId | type: string | description: Job GUID of the pausing of the program. Retrieve job details using the [Async Job API](https://dev.wix.com/docs/rest/business-management/async-job/introduction.md). 

 Possible Errors:
   HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: IN_PROGRESS | Description: Program pausing is in progress.
   HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: ALREADY_EXECUTED | Description: Program was already paused.
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: PROGRAM_STATUS_TRANSITION_NOT_ALLOWED | Description: Program isn't active and can't be paused.


```

### Examples

### PauseProgram
```curl
~~~cURL
curl --request POST https://www.wixapis.com/benefit-programs/v1/programs/pause \
  -H "Authorization: <AUTH>" \
  -H "Content-Type: application/json" \
  --data '{
    "program_id": "e5c42e1e-cd10-4210-b483-bb59932b1fa7"
  }'
~~~
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.benefitPrograms.ProgramService.pauseProgram(programId, options)
 Description: Pauses the specified program. Benefits in the program's pools can't be redeemed until the program is resumed.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  programId, options.idempotencyKey, options
 Method parameters: 
   param name: options | type: PauseProgramOptions  none | required: true
        - name: idempotencyKey | type: string | description: Idempotency key to ensure that the request is processed only once. | required: true
   param name: programId | type: string | description: GUID of the program to pause. | required: true
 Return type: PROMISE<PauseProgramResponse>
  - name: jobId | type: string | description: Job GUID of the pausing of the program. Retrieve job details using the [Async Job API](https://dev.wix.com/docs/rest/business-management/async-job/introduction.md). 

 Possible Errors:
   HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: IN_PROGRESS | Description: Program pausing is in progress.
   HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: ALREADY_EXECUTED | Description: Program was already paused.
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: PROGRAM_STATUS_TRANSITION_NOT_ALLOWED | Description: Program isn't active and can't be paused.


```

### Examples

### pauseProgram
```javascript
import { programs } from '@wix/benefit-programs';

async function pauseProgram(programId,options) {
  const response = await programs.pauseProgram(programId,options);
};
```

### pauseProgram (with elevated permissions)
```javascript
import { programs } from '@wix/benefit-programs';
import { auth } from '@wix/essentials';

async function myPauseProgramMethod(programId,options) {
  const elevatedPauseProgram = auth.elevate(programs.pauseProgram);
  const response = await elevatedPauseProgram(programId,options);
}
```

### pauseProgram (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { programs } from '@wix/benefit-programs';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { programs },
  // Include the auth strategy and host as relevant
});


async function pauseProgram(programId,options) {
  const response = await myWixClient.programs.pauseProgram(programId,options);
};
```

---