AlertSettings

Create alert settings

Changed on

Configure a subscription, line item, or group spend alert.

post/alerts/setting

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/alerts/setting
  • Auth
    API key in header x-api-key

Request body

entity_idstring required

entity_id is the id of the monitored entity: subscription id, subscription_line_item id, or group id, matching entity_type.

entity_type'wallet' | 'feature' | 'subscription' | 'subscription_line_item' | 'group' | 'entitlement_grant' required
parent_entity_idstring

parent_entity_id is the subscription id that owns a line-item or group alert. Required when entity_type is "subscription_line_item" or "group"; omitted for subscription-level alerts.

parent_entity_type'wallet' | 'feature' | 'subscription' | 'subscription_line_item' | 'group' | 'entitlement_grant'

Response

Created

created_atstring date-time
created_bystring
enabledboolean
entity_idstring
entity_type'wallet' | 'feature' | 'subscription' | 'subscription_line_item' | 'group' | 'entitlement_grant'
environment_idstring
idstring
parent_entity_idstring
parent_entity_typestring
status'published' | 'deleted' | 'archived'
tenant_idstring
updated_atstring date-time
updated_bystring

Changes

  • e36fe54e0efbRevision changes
    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

  • 50b7421a9690Revision changes
    • warning

      added the new entitlement_grant enum value to the response property for the response status

    • info

      added the new entitlement_grant enum value to the request property

    • info

      added the new entitlement_grant enum value to the request property