Skip to main content
POST
/
webhook-events
/
feature.wallet_balance.alert
feature.wallet_balance.alert
curl --request POST \
  --url https://us.api.flexprice.io/v1/webhook-events/feature.wallet_balance.alert
{
  "alert_status": "<string>",
  "alert_type": "<string>",
  "customer": {
    "address_city": "<string>",
    "address_country": "<string>",
    "address_line1": "<string>",
    "address_line2": "<string>",
    "address_postal_code": "<string>",
    "address_state": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "email": "<string>",
    "environment_id": "<string>",
    "external_id": "<string>",
    "id": "<string>",
    "integrations": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "entity_id": "<string>",
        "entity_type": "customer",
        "environment_id": "<string>",
        "id": "<string>",
        "provider_entity_id": "<string>",
        "provider_type": "<string>",
        "status": "published",
        "tenant_id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      }
    ],
    "metadata": {},
    "name": "<string>",
    "status": "published",
    "tenant_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "<string>"
  },
  "event_type": "subscription.created",
  "feature": {
    "alert_settings": {
      "alert_enabled": true,
      "critical": {
        "condition": "above",
        "threshold": 123
      },
      "info": {
        "condition": "above",
        "threshold": 123
      },
      "warning": {
        "condition": "above",
        "threshold": 123
      }
    },
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "description": "<string>",
    "environment_id": "<string>",
    "group": {
      "created_at": "2023-11-07T05:31:56Z",
      "entity_ids": [
        "<string>"
      ],
      "entity_type": "<string>",
      "id": "<string>",
      "lookup_key": "<string>",
      "metadata": {},
      "name": "<string>",
      "status": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "group_id": "<string>",
    "id": "<string>",
    "lookup_key": "<string>",
    "metadata": {},
    "meter": {
      "aggregation": {
        "bucket_size": "MONTH",
        "expression": "<string>",
        "field": "<string>",
        "group_by": "<string>",
        "multiplier": "<string>",
        "type": "COUNT"
      },
      "created_at": "2024-03-20T15:04:05Z",
      "event_name": "api_request",
      "filters": [
        {
          "key": "<string>",
          "values": [
            "<string>"
          ]
        }
      ],
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "API Usage Meter",
      "reset_usage": "BILLING_PERIOD",
      "status": "published",
      "tenant_id": "tenant123",
      "updated_at": "2024-03-20T15:04:05Z"
    },
    "meter_id": "<string>",
    "name": "<string>",
    "reporting_unit": {
      "conversion_rate": 123,
      "unit_plural": "<string>",
      "unit_singular": "<string>"
    },
    "status": "published",
    "tenant_id": "<string>",
    "type": "metered",
    "unit_plural": "<string>",
    "unit_singular": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "<string>"
  },
  "wallet": {
    "alert_settings": {
      "alert_enabled": true,
      "critical": {
        "condition": "above",
        "threshold": 123
      },
      "info": {
        "condition": "above",
        "threshold": 123
      },
      "warning": {
        "condition": "above",
        "threshold": 123
      }
    },
    "alert_state": "ok",
    "auto_topup": {
      "amount": 123,
      "enabled": true,
      "invoicing": true,
      "threshold": 123
    },
    "balance": "<string>",
    "config": {
      "allowed_price_types": [
        "ALL"
      ]
    },
    "conversion_rate": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "credit_balance": "<string>",
    "credits_available_breakdown": {
      "free": "<string>",
      "purchased": "<string>"
    },
    "currency": "<string>",
    "customer_id": "<string>",
    "description": "<string>",
    "environment_id": "<string>",
    "id": "<string>",
    "metadata": {},
    "name": "<string>",
    "status": "published",
    "tenant_id": "<string>",
    "topup_conversion_rate": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "<string>",
    "wallet_status": "active",
    "wallet_type": "PRE_PAID"
  }
}

Response

200 - application/json

Webhook payload

alert_status
string
alert_type
string
customer
object

Customer response object containing all customer information

event_type
enum<string>
Available options:
subscription.created,
subscription.draft.created,
subscription.activated,
subscription.updated,
subscription.paused,
subscription.cancelled,
subscription.resumed,
subscription.phase.created,
subscription.phase.updated,
subscription.phase.deleted,
feature.created,
feature.updated,
feature.deleted,
feature.wallet_balance.alert,
entitlement.created,
entitlement.updated,
entitlement.deleted,
wallet.created,
wallet.updated,
wallet.terminated,
wallet.transaction.created,
payment.created,
payment.updated,
payment.failed,
payment.success,
payment.pending,
customer.created,
customer.updated,
customer.deleted,
invoice.update.finalized,
invoice.update.payment,
invoice.update.voided,
invoice.update,
invoice.payment.overdue,
wallet.credit_balance.dropped,
wallet.credit_balance.recovered,
wallet.ongoing_balance.dropped,
wallet.ongoing_balance.recovered,
subscription.renewal.due,
invoice.communication.triggered,
credit_note.created,
credit_note.updated
feature
object
wallet
object