Get customer's PBX subscriptions
Fetch active PBX subscription and their Cloud PBX data, filtrated by given parameters. Returns data with pagination. Each Cloud PBX also contains data about its billing.
Query Parameters
Accepts a list of frequency values to filter by. Will return subscriptions that have any of the frequencies provided. If the list is empty – this filter is ignored.
Optional field. Allows to filter by activation price of the subscription. Will return subscription with activation price greater than and equal to the provided value.
0 <= valueOptional field. Allows to filter by activation price of the subscription. Will return subscription with activation price less than and equal to the provided value.
0 <= valuePagination parameters. Accepts page number. Pagination starts on page=1. If parameter is not provided, the default value of 1 will be set.
Pagination parameter. Accepts the size of page for pagination. Minimal page size is 1. If parameter is not provided, the default value of 10 will be set.
Accepts a list of subscriptions' unique ids to filter by. If the list is empty – this filter is ignored.
Time period filter, determines the end of the period. Accepts string with time either as UNIX timestamp, or in format 2006-01-02T15:04:05Z07:00.
Time period filter, determines the start of the period. Accepts string with time either as UNIX timestamp, or in format 2006-01-02T15:04:05Z07:00.
Accepts a list of PBX plans unique ids to filter by. Only subscription with these plans will be returned. If the list is empty, this filter will be ignored. Plan IDs can be obtained from GET /api/v1/pbx/plans.
Optional parameter that allows to search Cloud PBXs by name, subscription plan's title and/or description values. The search operation is partial.
Ordering parameter. Defines by which field the data will be sorted. If parameter is not provided, will be used entity's default ordering. To use entity's default sorting, pass _default as value.
"_default" | "id" | "name" | "title" | "description" | "activation" | "monthly" | "amount_one_time" | "subscription_amount" | "created_at" | "activated_at"Ordering parameter. Defines the order of sorting (asc or desc). If parameter is not provided, will be used entity's default ordering.
"asc" | "desc"Optional field. Allows to filter by monthly price of the subscription. Will return subscription with monthly price greater than and equal to the provided value.
0 <= valueOptional field. Allows to filter by monthly price of the subscription. Will return subscription with monthly price less than and equal to the provided value.
0 <= valueHeader Parameters
Your API token
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://dev-refactor-api-e.voipenv.uk/api/v1/pbx/subscriptions" \ -H "Authorization: string"{
"data": [
{
"activated_at": "string",
"activation": 0,
"comment": "string",
"frequency": "monthly",
"id": 0,
"monthly": 0,
"name": "string",
"next_payment_at": "string",
"plan": {
"activation": 0,
"concurrent_call_capacity": 0,
"description": "string",
"extension_capacity": 0,
"frequency": "monthly",
"id": 0,
"monthly": 0,
"recording_capacity": 0,
"sub_plans": [
{
"activation": 0,
"concurrent_call_capacity": 0,
"description": "string",
"extension_capacity": 0,
"frequency": "monthly",
"id": 0,
"monthly": 0,
"recording_capacity": 0,
"sub_plans": [],
"title": "string"
}
],
"title": "string"
},
"subscription_status": "disabled",
"url": "string"
}
],
"page": 0,
"page_size": 0,
"total": 0,
"total_pages": 0
}{
"code": 0,
"error_details": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"message": "string",
"request_id": "string",
"status": "error"
}{
"code": 0,
"error_details": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"message": "string",
"request_id": "string",
"status": "error"
}{
"code": 0,
"error_details": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"message": "string",
"request_id": "string",
"status": "error"
}
