# POST /api/customers/recurring-billing/trigger

Manually trigger a recurring billing workflow execution.

**Required permissions**: `Customers.RecurringBilling.Trigger`  
**Scope**: merchant

**Operation ID:** `POST_api_customers_recurring-billing_trigger`

## Authorization

Requires: Customers.RecurringBilling.Trigger, merchant scope.

Required permissions:
- `Customers.RecurringBilling.Trigger`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

Optional scope filters and reason.

**Content type:** `application/json`

Schema: `PhoeniXGateCustomersRecurringBillingTriggerRecurringBillingRequestDto`

**Content type:** `text/json`

Schema: `PhoeniXGateCustomersRecurringBillingTriggerRecurringBillingRequestDto`

**Content type:** `application/*+json`

Schema: `PhoeniXGateCustomersRecurringBillingTriggerRecurringBillingRequestDto`

## Responses

### 200

OK

**Content type:** `text/plain`

Schema: `PhoeniXGateCustomersRecurringBillingTriggerRecurringBillingResponseDto`

**Content type:** `application/json`

Schema: `PhoeniXGateCustomersRecurringBillingTriggerRecurringBillingResponseDto`

**Content type:** `text/json`

Schema: `PhoeniXGateCustomersRecurringBillingTriggerRecurringBillingResponseDto`

### 403

Forbidden

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 401

Unauthorized

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 400

Bad Request

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 404

Not Found

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 501

Not Implemented

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 500

Internal Server Error

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

## See also

- [All documentation](https://docs.winkpg.io/llms.txt): the machine-readable index of every public page on this site.