VendorSubscriptionsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| listSubscriptionPlans | GET /vendors/subscriptions/plans | List subscription plans |
| listVendorSubscriptionPlans | GET /vendors/subscription-plans | List available subscription plans for vendors |
| vendorSubscribeToPlan | POST /vendors/subscription-plans/subscribe | Subscribe 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
| Name | Type | Description | Notes |
|---|---|---|---|
| country_code | String | Country code to filter plans by regional availability (required) | [default to null] |
| plan_type | SubscriptionPlanTypeFilter | Plan type filter (omit for all plans) | [optional] [default to null] [enum: vendor, partner] |
| page | Integer | Page number for pagination (starts at 1) | [optional] [default to null] |
| per_page | Integer | Number 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
| Name | Type | Description | Notes |
|---|---|---|---|
| country_code | String | [optional] [default to null] | |
| page | Integer | [optional] [default to null] | |
| per_page | Integer | [optional] [default to null] |
Return type
PaginatedResponse_ListedSubscriptionPlan
Authorization
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
| Name | Type | Description | Notes |
|---|---|---|---|
| SubscribeToPlanRequest | SubscribeToPlanRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8