Billing events

📘

Meta charges for service conversation messages sent by business - w.e.f Oct 01, 2026. They do not bill the first 1000 messages in a month which will be categorized as 'Free Tier Conversations'

The billing-event informs you if a conversation is billable or not. Learn more about Conversation based pricing.

{
    "app": "DemoAPI",
    "timestamp":1580546677791,
    "version":2,
    "type": "billing-event",
    "payload":
  	{
      "deductions":
      {
            "type": "marketing/authentication/utility/service/FEP/FTC",
            "conversationType": "service",
            "model": "NBP/CBP",
            "source": "whatsapp",
            "billable":"true/false",
        		"category": "marketing lite",
       },
       "references":
      {
        "id":"59f8db90c37e-4408-90ab-cc54ef8246ad",
        "gsId":"ee4a68a0-1203-4c85-8dc3-49d0b3226a35",
        "conversationId":"532b57b5f6e63595ccd74c6010e5c5c7",
        "destination":"91XX985XX10X"
      }
    }
}

Deductions - Object Description

KeyDescriptionExample
typeThe type of conversation. Possible values:
  • FEP (Free entry point)
  • Marketing
  • Authentication
  • Utility -Service
  • FTC (Free Tier conversation)
Marketing
conversationTypeThe type of FTC (Free Tier Conversation). This parameter is only received for type FTC.
If type='FTC' then conversationType is "service"
Service
category
  • marketing
  • marketing_lite
  • utility
  • authentication
  • authentication_international
  • service
  • referral_conversion
marketing_lite
modelThe pricing policy model applied for this message. Possible values:
  • CBP (Conversation based pricing)
  • NBP (Notification based pricing)
CBP
sourceOrigin source of the conversationwhatsapp
billableThe value is either true or false depending on whether a conversation is billable or not.false

References - Object Description

KeyDescriptionExample
idUnique WhatsApp identifier for a message59f8db90c37e-4408-90ab-cc54ef8246ad
gsIdUnique Gupshup identifier for a messageee4a68a0-1203-4c85-8dc3-49d0b3226a35
conversationIdUnique identifier for a conversation532b57b5f6e63595ccd74c6010e5c5c7
destinationPhone number of the user engaged in the conversation.
Phone Number will be in E.164 format.
91XX985XX10X

MM Lite Bidding / Max Price

The following example shows billing payload for MM Lite bidding / Max Price, with the category marketing_lite_dynamic.

Sample Payload

[
  {
    "changes": [
      {
        "field": "billing-event",
        "value": {
          "billing": {
            "deductions": {
              "billable": true,
              "category": "marketing_lite_dynamic",
              "model": "PMP",
              "source": "whatsapp",
              "type": "regular"
            },
            "references": {
              "destination": "919131210181",
              "gs_id": "8ae79be7-8e2d-456d-b181-1c762c6a009b",
              "id": "10314pO71j2g3119119i2EYa6ZX2Z",
              "user_id": "IN.969686396164426"
            }
          }
        }
      }
    ]
  }
]

Payload Description

KeyDescriptionExample
changesAn array detailing the specific changes in the billing event.See the sample payload.
fieldSpecifies the type of event. For billing events, this is set to billing-event.billing-event
valueContains the billing information.See the sample payload.
billingHolds the deductions and references related to the billing event.See the sample payload.
deductionsDetails about the billing deductions.See the sample payload.
billableThe value is either true or false depending on whether a conversation is billable or not.true
categoryPricing category of the message. For MM Lite bidding / Max Price, the category is marketing_lite_dynamic.marketing_lite_dynamic
modelThe pricing policy model applied for this message.PMP
sourceOrigin source of the conversation.whatsapp
typeBilling type reported for this event.regular
referencesProvides additional information related to the billing event.See the sample payload.
destinationPhone number of the user engaged in the conversation. Phone number will be in E.164 format.919131210181
gs_idUnique Gupshup identifier for a message.8ae79be7-8e2d-456d-b181-1c762c6a009b
idUnique WhatsApp identifier for a message.10314pO71j2g3119119i2EYa6ZX2Z
user_idUser identifier associated with the billing event.IN.969686396164426

Call Interactions

This document outlines the structure and fields of billing events related to call interactions.

Sample Payload

{
	"entry":
  [
		{
			"changes":
      [
				{
					"field": "billing-event",
					"value":
          {
						"billing":
            {
							"deductions":
              {
								"billable": "true/false",
								"conversation_type": "call",
								"source": "whatsapp"
                "category": "marketing lite",
							},
							"references":
              {
								"conversation_type": "MESSAGE/CALL",
								"destination": "9191638XXXXX",
								"source": "9112fXXXXXX",
								"direction": "[USER_INITIATED|BUSINESS_INITIATED]",
								"id": "WHATSAPP_CALL_ID",
								"duration": "12321",
								"start_time": "",
								"end_time": ""
							}
						}
					}
				}
			]
		}
	],
	"gs_app_id": "GUPSHUP_APP_ID",
	"object": "whatsapp_business_account"
}

Root-Level Field Descriptions

KeyDescription
entryAn array containing event entries. Each entry represents a change related to a billing event.
changesAn array detailing the specific changes in the billing event.
fieldSpecifies the type of event. For billing events, this is set to "billing-event".
valueContains the billing information.
billingHolds the deductions and references related to the billing event.
deductionsDetails about the billing deductions.
billableIndicates whether the wallet is deducted for this event. Possible values are "true" or "false".
conversation_typeSpecifies the type of conversation. In this context, it is "call".
sourceDenotes the source of billing, e.g., "whatsapp".
referencesProvides additional information related to the billing event.
conversation_typeRefers to the type of conversation, either "MESSAGE" or "CALL".
destinationThe recipient's phone number.
sourceThe sender's phone number.
directionIndicates the direction of the call, either "USER_INITIATED" or "BUSINESS_INITIATED".
idThe unique identifier for the WhatsApp call.
durationThe duration of the call in seconds.
start_timeThe start time of the call.
end_timeThe end time of the call.
gs_app_idThe unique identifier for the Gupshup application.
objectSpecifies the object type, in this case, "whatsapp_business_account".

Sample Meta Billing Event

{
	"entry": [
		{
			"changes": [
				{
					"field": "billing-event",
					"value": {
						"billing": {
							"deductions": {
								"billable": "true",
								"conversation_type": "call",
								"source": "whatsapp"
							},
							"references": {
								"conversation_type": "CALL",
								"destination": "919355015912",
								"direction": "USER_INITIATED",
								"duration": 18,
								"end_time": 1743598139,
								"id":"wacid.HBgMOTE5NjQzNTk1NDUyFQIAEhggMTczN0EzM0E4Q0MyRjk5RUQwQzQwRTZBQjk5NkRDODQcGAw5MTkzNTUwMTU5MTIVAgAA",
								"source": "919643595452",
								"start_time": 1743598121
							}
						}
					}
				}
			],
			"time": 1743598141518
		}
	],
	"gs_app_id": "b6016edd-12fb-4da1-8e96-e5bb634e271f",
	"object": "whatsapp_business_account"
}

Sample GS Billing Event

{
	"entry": [
		{
			"changes": [
				{
					"field": "billing-event",
					"value": {
						"billing": {
							"deductions": {
								"billable": "false",
								"conversation_type": "call",
								"source": "gupshup"
							},
							"references": {
								"conversation_type": "CALL",
								"destination": "919355015912",
								"direction": "USER_INITIATED",
								"duration": 18,
								"end_time": 1743598139,
								"id":"wacid.HBgMOTE5NjQzNTk1NDUyFQIAEhggMTczN0EzM0E4Q0MyRjk5RUQwQzQwRTZBQjk5NkRDODQcGAw5MTkzNTUwMTU5MTIVAgAA",
								"source": "919643595452",
								"start_time": 1743598121
							}
						}
					}
				}
			],
			"time": 1743598141518
		}
	],
	"gs_app_id": "b6016edd-12fb-4da1-8e96-e5bb634e271f",
	"object": "whatsapp_business_account"
}

Did this page help you?