Event on Application Payment onAppPayment

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: basic

Who can subscribe: any user

The ONAPPPAYMENT event is triggered when an application is paid for.

Events will not be sent to the application until the installation is complete. Check the application installation

What the Handler Receives

Data is transmitted as a POST request

{
            "event": "ONAPPPAYMENT",
            "data": {
                "CODE": "bitrix.gds_company",
                "VERSION": 1,
                "STATUS": "S",
                "PAYMENT_EXPIRED": "N",
                "DAYS": 28,
                "LANGUAGE_ID": "de"
            },
            "ts": "1466439714",
            "auth": {
                "domain": "some-domain.bitrix24.com",
                "server_endpoint": "https://oauth.bitrix.info/rest/",
                "client_endpoint": "https://some-domain.bitrix24.com/rest/",
                "member_id": "a223c6b3710f85df22e9377d6c4f7553"
            }
        }

Request Parameters

Required parameters are marked with *

Name
type

Description

event*
string

Event character code — ONAPPPAYMENT

data*
object

Payment data.

The structure is described below

ts*
timestamp

Date and time of the event sent from the queue

auth*
object

Authorization and account data.

The structure is described below

Parameter data

Name
type

Description

CODE*
string

Application code

VERSION*
integer

Installed application version

STATUS*
string

Application status. Possible values:

  • F (Free) — free
  • D (Demo) — demo version
  • T (Trial) — trial version, time-limited
  • P (Paid) — paid application

PAYMENT_EXPIRED*
string

[Y|N] Flag indicating whether the paid period or trial period has expired

DAYS*
integer

Number of days remaining until the end of the paid period or trial period

LANGUAGE_ID*
string

Set language: ru, en and others

Parameter auth

Name
type

Description

domain*
string

Address of the Bitrix24 account where the event occurred

server_endpoint*
string

Authorization server address for token renewal

client_endpoint*
string

Common path for API method calls to the account

member_id*
string

Unique identifier of the account

Continue Learning

Previous
When Uninstalling the Application
Next
When Receiving Permission to Use Methods