Skip to Content

CancellationReasonsApi

All URIs are relative to https://business.apis.kesk.app/v1 

MethodHTTP requestDescription
getCancellationReasonsGET /cancellation-reasonsList cancellation reasons, optionally filtered by type

getCancellationReasons

PaginatedResponse_CancellationReasonResponse getCancellationReasons(type_, page, per_page)

List cancellation reasons, optionally filtered by type

Retrieves available cancellation reasons that users can choose from when cancelling. Reasons can be filtered by type (e.g., “order”, “subscription”) to show only relevant options based on what the user is cancelling.

Parameters

NameTypeDescriptionNotes
type_StringOptional type filter to show reasons for specific cancellation contexts[optional] [default to null]
pageIntegerPage number for pagination (starts at 1)[optional] [default to null]
per_pageIntegerNumber of items per page (default: 20)[optional] [default to null]

Return type

PaginatedResponse_CancellationReasonResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8