Pour les agents IA : markdown de cette page — /docs-content-en/entities/recurring-deals.md index de la documentation — /llms.txt

Les articles de documentation sont actuellement disponibles en anglais.

Recurring deals

Recurring settings describe automatic deal creation, for example a monthly subscription. The recurring settings ID differs from the template deal ID. Availability depends on your Bitrix24 plan.

Bitrix24 API: crm.deal.recurring.*

Scope: crm

List recurring deals

GET /v1/recurring-deals

Supports filter, sort, select, limit, offset. params cannot be filtered or sorted.

Response fields

Field Type Meaning
success boolean Success flag
data array Recurring settings; see fields
meta.total number Total count, when requested
meta.hasMore boolean Whether more rows remain

Example

curl — personal key

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/recurring-deals" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/recurring-deals" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/recurring-deals', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const result = await response.json()
if (!result.success) throw new Error(result.error.message)
console.log(result.data)

JavaScript — OAuth application

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/recurring-deals', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_APP_KEY', 'Authorization': 'Bearer USER_SESSION_TOKEN' },
})
const result = await response.json()
if (!result.success) throw new Error(result.error.message)
console.log(result.data)

Errors

HTTP Code Condition
401 MISSING_API_KEY API key missing
403 SCOPE_DENIED crm scope missing
400 INVALID_PARAMS Invalid ID, enum or value shape
403 BITRIX_ACCESS_DENIED Bitrix24 refused access
422 BITRIX_ERROR Original Bitrix24 business refusal or plan limitation

System errors. Batch sub-call errors are returned within the batch result.

MCP: generic entity tools with entity: "recurring-deals"; expose uses call_api with POST and this path.

See also