Skip to Content

VendorSubscriptionsApi

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

MethodHTTP requestDescription
listSubscriptionPlansGET /vendors/subscriptions/plansList subscription plans
listVendorSubscriptionPlansGET /vendors/subscription-plansList available subscription plans for vendors
vendorSubscribeToPlanPOST /vendors/subscription-plans/subscribeSubscribe to a plan as a vendor

listSubscriptionPlans

PaginatedResponse_ListedSubscriptionPlan listSubscriptionPlans(country_code, plan_type, page, per_page)

List subscription plans

Retrieves subscription plans available in a specific country, optionally filtered by plan type. Returns comprehensive plan details including pricing tiers, billing cycles, and feature lists.

Parameters

NameTypeDescriptionNotes
country_codeStringCountry code to filter plans by regional availability (required)[default to null]
plan_typeSubscriptionPlanTypeFilterPlan type filter (omit for all plans)[optional] [default to null] [enum: vendor, partner]
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_ListedSubscriptionPlan

Authorization

No authorization required

HTTP request headers

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

listVendorSubscriptionPlans

PaginatedResponse_ListedSubscriptionPlan listVendorSubscriptionPlans(country_code, page, per_page)

List available subscription plans for vendors

Parameters

NameTypeDescriptionNotes
country_codeString[optional] [default to null]
pageInteger[optional] [default to null]
per_pageInteger[optional] [default to null]

Return type

PaginatedResponse_ListedSubscriptionPlan

Authorization

JwtAuthScheme

HTTP request headers

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

vendorSubscribeToPlan

SubscribeToPlanResponse vendorSubscribeToPlan(SubscribeToPlanRequest)

Subscribe to a plan as a vendor

Parameters

NameTypeDescriptionNotes
SubscribeToPlanRequestSubscribeToPlanRequest

Return type

SubscribeToPlanResponse

Authorization

JwtAuthScheme

HTTP request headers

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