latestSwagger 2.02026-08-109450223.9 KB

94acb422c07d

Reseller

List Reseller Subscriptions

Shows subscriptions associated with the current reseller's managed accounts.

Note: This endpoint will also return a pagination key on the root level. Please refer to the pagination section within our docs for more information.

get/v1/reseller/subscriptions

Query parameters

limitinteger

Max number of resources returned in a paged collection. Defaults to 10, with a minimum of 1 and maximum 500.

page_tokenstring

Token used to request the next page in paginated results. Defaults to 'null'

sort_field'id' | 'status' | 'minimum' | 'created_at' | 'updated_at'

Field to sort by. Defaults to 'id'.

sort_direction'asc' | 'desc'

Sort direction. Defaults to 'desc'.

product'edr' | 'ispm' | 'itdr' | 'sat' | 'siem'

Filter by product type

status'draft' | 'approved' | 'accepted' | 'active' | 'completed'

Filter by status

Response

List Reseller Subscriptions

Example response

{
  "subscriptions": [
    {
      "id": 1,
      "account": {
        "id": 1,
        "name": "Little Bobby's Table Emporium"
      },
      "product": "edr",
      "status": "active",
      "minimum_usage": 50,
      "terminal_minimum_usage": 100,
      "billing_interval": "monthly",
      "effective_date": "2024-01-01T00:00:00Z",
      "renewal_date": "2025-01-01T00:00:00Z",
      "auto_renew": true,
      "schedules": [
        {
          "id": 1,
          "minimum": 100,
          "maximum": 500,
          "status": "active",
          "target_price": 200,
          "months": 12,
          "promo_units": 0,
          "starts_at": "2024-01-01T00:00:00Z",
          "ends_at": "2025-01-01T00:00:00Z"
        }
      ]
    }
  ]
}