Sign in

v1

latestOpenAPI 3.0.12026-07-265331168.0 KB
Service

Search Services

Search Services on the customer account using various filters.

get/public/user/service/search

Query parameters

service_idstring

ID of the service

service_status'awaiting_fulfillment' | 'awaiting_manual_fulfillment' | 'awaiting_additional_fulfillment' | 'active' | 'canceled' | 'complete' | 'overdue' | 'paused'

Current status of the service

service_namestring

Name of the service

service_type'datacenter' | 'isp' | 'residential' | 'mobile'

Type of the service

service_protocol'ipv4' | 'ipv6' | 'dual'

Protocol of the service

service_quantityinteger

Quantity of the service

payment_method_idinteger

Payment method ID of the service

service_totalstring

Total amount of the service

service_cyclestring

Service cycle (e.g., "1:month")

service_dispatch_datetimestring date-time

Datetime the service was dispatched

service_expiry_datetimestring date-time

Datetime the service will expire

service_imagestring

URL of the service image

service_is_automatic_collectionboolean

If the service is set for automatic collection

service_is_pending_cancellationboolean

If the service is pending cancellation

country_idstring

ISO Country Code (ISO 3166-1 alpha-2)

service_price_idinteger

Price ID of the service

product_idinteger

Product ID of the service

service_promotional_codestring

Promotional code of the service

service_subscription_idinteger

Subscription ID of the service

service_creation_datetimestring date-time

Datetime the service was created

service_last_update_datetimestring date-time

Datetime the service was last updated

proxiesboolean

If the proxies associated with the service should be returned

per_pageinteger

Number of items per page for pagination

pageinteger

Page number for pagination

sort_bystring

Key for sorting or random.

Response

Successful Service search

item_countinteger

Total number of Service items returned in the data field.

messagestring

Status message for the search.

pageinteger

Current page number of the search results returned.

per_pageinteger

Number of Service items returned per page.

total_countinteger

Total of Service items that match the search filter.

Example response

{
  "data": [
    {
      "country_id": "us",
      "open_invoice_id": "inv_1OCNVFFKo7UQ3XWITWlqGWYQ",
      "payment_method_id": "pm_1NjyqfB2BUlqim5l2LgRUo0a",
      "service_creation_datetime": "2023-09-12 10:00:00",
      "service_cycle": "1:month",
      "service_dispatch_datetime": "2023-09-12 11:00:00",
      "service_earliest_cancellation_datetime": "2023-09-12 12:00:00",
      "service_expiry_datetime": "2023-10-12 10:00:00",
      "service_id": "API-1234-5678",
      "service_image": "https://apple.com/image.png",
      "service_is_automatic_collection": true,
      "service_is_pending_cancellation": false,
      "service_last_update_datetime": "2023-09-12 12:00:00",
      "service_metadata": {
        "resell_customer_id": "APPL-9876-5432"
      },
      "service_name": "Premium ISP",
      "service_promotional_code": "PROMO2023",
      "service_protocol": "ipv4",
      "service_quantity": 5,
      "service_status": "active",
      "service_subscription_id": "sub_1NpPVfB2BUlqim5lA374YoIh",
      "service_subscription_is_paused": false,
      "service_total": 100,
      "service_type": "isp",
      "subscription_schedule_id": "sub_sched_1OCNVFFKo7UQ3XWITWlqGWYQ"
    }
  ],
  "item_count": 1,
  "message": "Service search successful.",
  "page": 1,
  "per_page": 10,
  "total_count": 1
}