Billing events

Suggest Edits

📘
There is no Meta fees charged for service conversations 1st Nov onwards, hence the billable parameter will be false for service 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"
       },
        "references":{
            "id":"59f8db90c37e-4408-90ab-cc54ef8246ad",
            "gsId":"ee4a68a0-1203-4c85-8dc3-49d0b3226a35",
            "conversationId":"532b57b5f6e63595ccd74c6010e5c5c7",
            "destination":"91XX985XX10X"
        }
    }
}

deductions object description

Key	Description	Example
`type`	The type of conversation. Possible values: - FEP (Free entry point) - Marketing - Authentication - Utility -Service - FTC (Free Tier conversation)	Marketing
`conversationType`	The type of FTC(Free Tier Conversation). This parameter is only received for `type` FTC. If type='FTC' then conversationType is "service"	Service
`model`	The pricing policy model applied for this message. Possible values: - CBP (Conversation based pricing) - NBP (Notification based pricing)	CBP
`source`	Origin source of the conversation	whatsapp
`billable`	The value is either `true` or `false` depending on whether a conversation is billable or not.	false

references object description

Key	Description	Example
`id`	Unique WhatsApp identifier for a message	59f8db90c37e-4408-90ab-cc54ef8246ad
`gsId`	Unique Gupshup identifier for a message	ee4a68a0-1203-4c85-8dc3-49d0b3226a35
`conversationId`	Unique identifier for a conversation	532b57b5f6e63595ccd74c6010e5c5c7
`destination`	Phone number of the user engaged in the conversation. Phone Number will be in E.164 format.	91XX985XX10X

Updated about 1 month ago

What’s Next

In the next chapter of this guide, you'll learn about subscriptions and notifications.

Subscriptions and notifications