Skip to main content

list entitlement cancellation requests

GET 
/org/:orgId/entitlement/:entitlementId/cancel

List entitlement cancellation requests with advanced filtering, sorting, and pagination.

Request​

Path Parameters

    orgId stringrequired

    Organization ID

    entitlementId stringrequired

    Entitlement ID

Query Parameters

    page_size integer

    Number of items per page (default 20, max 1000)

    page_number integer

    Page number (default 1)

    q string

    LISP-style filter expression (e.g., '(= status \

    s string

    Sort fields: 'field:asc,field2:desc' or '-field,field2' format (e.g., 'created_at:desc,status:asc')

Body

    object

Responses​

Paginated list of entitlement cancellation requests

Schema

    data

    object[]

  • Array [

    • createdAt date-time

    CreatedAt holds the value of the "created_at" field.

    createdBy

    object

    CreatedBy holds the value of the "created_by" field.

    email string

    The email of the creator.

    entityId string

    The ID of the creator.

    entityType EntityType (string)

    Possible values: [``, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, FUNDING_APPLICATION, HEADLESS_ENTITLEMENTS, HUBSPOT_USER, INTEGRATION, INTERNAL_ACTION_REQUEST, INVOICE, JOIN_ORG_REQUEST, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SERVICE, SUPPORT_TICKET, UNPURCHASED_OFFERS, USAGE_RECORD_GROUP, USAGE_RECORD_REPORT, USER, WORKFLOW, WORKFLOW_EXECUTION, WORKFLOW_WEBHOOK, ORGANIZATION_INFO]

    The Entity type of the creator, either USER or API_CLIENT.

    name string

    The name of the creator.

    entitlementID string

    EntitlementID holds the value of the "entitlement_id" field.

    externalRequestID string

    ExternalRequestID holds the value of the "external_request_id" field.

    id string

    ID of the ent.

    info

    object

    Info holds the value of the "info" field.

    awsClientToken string

    AwsClientToken is the UUID client token for idempotency.

    awsReasonCode string

    AwsReasonCode is the cancellation reason code from AWS SDK.

    awsReasonDescription string

    AwsReasonDescription is the description of the cancellation reason.

    lastUpdatedAt date-time

    LastUpdatedAt holds the value of the "last_updated_at" field.

    organizationID string

    OrganizationID holds the value of the "organization_id" field.

    partner string

    Partner holds the value of the "partner" field.

    status string

    Status holds the value of the "status" field.

    statusMessage string

    StatusMessage holds the value of the "status_message" field.

  • ]

    • page_number integer
    page_size integer
    total_count integer
Loading...