Opt in

Receive notifications regarding your credit limit as it reaches specific thresholds. You have
the flexibility to opt-in for various levels based on your requirements. For instance, you can
choose to receive notifications at 90% of your credit limit or select multiple thresholds such
as 50%, 70%, and 90%. These notifications can be delivered either to your webhook or your
company email address.

Parameters

type (required)

"webhook_credit_limit": use this value to receive notification via webhook.

"email_credit_limit": use this value to receive notification via email.

If type provided is "webhook_credit_limit":

webhook_url (required): provide the URL of your Webhook implementation. Example: "https://example.com".
NOTE: The endpoint must support HEAD and POST HTTP methods.

If type provided is "email_credit_limit":

email (required): provide the email address to recieve the email notifications.

language(optional): language for the email based notifications. Example: “en”.

levels (optional): Credit limit thresholds at which notifications are triggered.

Must be a subset of: [50, 70, 80, 90].

Example: [70, 90] — notifications will be sent when usage exceeds 70% and 90%.

The response will include the contact_point field, which reflects the email or webhook URL you provided when opting in to the webhook.

You can provide your email address using the email parameter, which will send an email to your inbox asynchronously.
Below is a sample of the email notification.

curl --location '/v2/notifications/opt-in' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {{token}}' \ --header 'url: https://partners-api.airalo.com' \ --header 'Content-Type: application/json' \ --data '{ "type": "webhook_credit_limit", "webhook_url": "https://example.com", "levels": [ 50, 70, 80, 90 ] }'

{ "data": { "notification": { "type": "webhook_credit_limit", "contact_point": "https://example.com", "levels": [ 50, 70, 80, 90 ] } }, "meta": { "message": "success" } }

Request

Responses