Skip to main content
POST
/
webhook-events
/
entitlement.created
entitlement.created
curl --request POST \
  --url https://us.api.flexprice.io/v1/webhook-events/entitlement.created
{
  "entitlement": {
    "addon": {
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "description": "<string>",
      "entitlements": "<array>",
      "environment_id": "<string>",
      "id": "<string>",
      "lookup_key": "<string>",
      "metadata": {},
      "name": "<string>",
      "prices": [
        {
          "addon": "<unknown>",
          "amount": "<string>",
          "billing_cadence": "RECURRING",
          "billing_model": "FLAT_FEE",
          "billing_period": "MONTHLY",
          "billing_period_count": 123,
          "conversion_rate": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "currency": "<string>",
          "description": "<string>",
          "display_amount": "<string>",
          "display_name": "<string>",
          "display_price_unit_amount": "<string>",
          "end_date": "2023-11-07T05:31:56Z",
          "entity_id": "<string>",
          "entity_type": "PLAN",
          "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>",
          "invoice_cadence": "ARREAR",
          "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>",
          "min_quantity": "<string>",
          "parent_price_id": "<string>",
          "plan": {
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "credit_grants": [
              {
                "cadence": "ONETIME",
                "conversion_rate": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "created_by": "<string>",
                "credit_grant_anchor": "2023-11-07T05:31:56Z",
                "credits": "<string>",
                "end_date": "2023-11-07T05:31:56Z",
                "environment_id": "<string>",
                "expiration_duration": 123,
                "expiration_duration_unit": "DAY",
                "expiration_type": "NEVER",
                "id": "<string>",
                "metadata": {},
                "name": "<string>",
                "period": "DAILY",
                "period_count": 123,
                "plan_id": "<string>",
                "priority": 123,
                "scope": "PLAN",
                "start_date": "2023-11-07T05:31:56Z",
                "status": "published",
                "subscription_id": "<string>",
                "tenant_id": "<string>",
                "topup_conversion_rate": "<string>",
                "updated_at": "2023-11-07T05:31:56Z",
                "updated_by": "<string>"
              }
            ],
            "description": "<string>",
            "display_order": 123,
            "entitlements": "<array>",
            "environment_id": "<string>",
            "id": "<string>",
            "lookup_key": "<string>",
            "metadata": {},
            "name": "<string>",
            "prices": "<array>",
            "status": "published",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "price_unit": "<string>",
          "price_unit_amount": "<string>",
          "price_unit_id": "<string>",
          "price_unit_tiers": [
            {
              "flat_amount": "<string>",
              "unit_amount": "<string>",
              "up_to": 123
            }
          ],
          "price_unit_type": "FIAT",
          "pricing_unit": {
            "base_currency": "<string>",
            "code": "<string>",
            "conversion_rate": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "environment_id": "<string>",
            "id": "<string>",
            "metadata": {},
            "name": "<string>",
            "status": "published",
            "symbol": "<string>",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "start_date": "2023-11-07T05:31:56Z",
          "status": "published",
          "tenant_id": "<string>",
          "tier_mode": "VOLUME",
          "tiers": [
            {
              "flat_amount": "<string>",
              "unit_amount": "<string>",
              "up_to": 123
            }
          ],
          "transform_quantity": {
            "divide_by": 123,
            "round": "up"
          },
          "trial_period": 123,
          "type": "USAGE",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "status": "published",
      "tenant_id": "<string>",
      "type": "onetime",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "display_order": 123,
    "end_date": "2023-11-07T05:31:56Z",
    "entity_id": "<string>",
    "entity_type": "PLAN",
    "environment_id": "<string>",
    "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>"
    },
    "feature_id": "<string>",
    "feature_type": "metered",
    "id": "<string>",
    "is_enabled": true,
    "is_soft_limit": true,
    "parent_entitlement_id": "<string>",
    "plan": {
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "credit_grants": [
        {
          "cadence": "ONETIME",
          "conversion_rate": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "credit_grant_anchor": "2023-11-07T05:31:56Z",
          "credits": "<string>",
          "end_date": "2023-11-07T05:31:56Z",
          "environment_id": "<string>",
          "expiration_duration": 123,
          "expiration_duration_unit": "DAY",
          "expiration_type": "NEVER",
          "id": "<string>",
          "metadata": {},
          "name": "<string>",
          "period": "DAILY",
          "period_count": 123,
          "plan_id": "<string>",
          "priority": 123,
          "scope": "PLAN",
          "start_date": "2023-11-07T05:31:56Z",
          "status": "published",
          "subscription_id": "<string>",
          "tenant_id": "<string>",
          "topup_conversion_rate": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "description": "<string>",
      "display_order": 123,
      "entitlements": "<array>",
      "environment_id": "<string>",
      "id": "<string>",
      "lookup_key": "<string>",
      "metadata": {},
      "name": "<string>",
      "prices": "<array>",
      "status": "published",
      "tenant_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    },
    "plan_id": "<string>",
    "start_date": "2023-11-07T05:31:56Z",
    "static_value": "<string>",
    "status": "published",
    "tenant_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "<string>",
    "usage_limit": 123,
    "usage_reset_period": "MONTHLY"
  },
  "event_type": "subscription.created"
}

Response

200 - application/json

Webhook payload

​
entitlement
object
​
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