Skip to content
API Enriched

List Subscriptions.

GET
/api/web/namespaces/{namespace}/subscriptions/custom_list
curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/namespaces/example/subscriptions/custom_list \
  --header 'Authorization: <Authorization>'

Endpoint to list subscriptions.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace Namespace filter.

Query Parameters

Section titled “Query Parameters”
current
boolean format: boolean

Filter out inactive subscriptions.

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
List subscription response

Response to call to GET list of tenant subscriptions.

object
subscriptions

IP address configuration

Array<object>
Subscription record

Tenant subscription to the services record.

object
cancellation_date
Cancellation date

Date when subscription become cancelled.

string format: date-time
<= 1024 characters
cancelled
Cancelled

Flag shows if this subscription is already cancelled.

boolean format: boolean
current
Current

Flag shows if this subscription is currently active.

boolean format: boolean
last_billing_period_end_date
Billing period end date

The last day of the last billing_period.

string format: date-time
<= 1024 characters
last_billing_period_start_date
Billing period start date

The first day of the last billing_period.

string format: date-time
<= 1024 characters
name
Name

Name of the subscription (internal name, not human readable), a subscription has no human readable name.

string
>= 6 characters <= 1024 characters
plan_name
Plan name

Plan name

string
<= 1024 characters
plan_object_name
Plan object name

Plan object name.

string
<= 1024 characters
previous_billing_periods
Previous billing periods

List of the previous billing periods.

Array<object>
List subscription response

Response to call to GET list of tenant subscriptions.

object
closed_invoice
Closed invoices

Link to the closed invoice.

Array<string>
end_date
End date

Kast day of the last billing_period in external provider.

string format: date-time
<= 1024 characters
internal_end_date
Internal end date

Internal end date that serves as source of truth.

string format: date-time
<= 1024 characters
internal_start_date
Internal start date

Internal start date that serves as source of truth.

string format: date-time
<= 1024 characters
invoices
Invoices

Link to all of the invoices for this period.

Array<string>
pending_invoice
Open invoices

Link to the pending invoice.

Array<string>
start_date
Start date

The first day of the last billing_period in external provider.

string format: date-time
<= 1024 characters
trial
Trial

Flag shows if this billing time frame is part of trial period.

boolean format: boolean
uid
UUID

Unique identifier of this time frame.

string format: uuid
>= 36 characters <= 1024 characters
start_date
Start date

Date when subscription become active.

string format: date-time
<= 1024 characters
Examplegenerated
{
  "subscriptions": [
    {
      "cancellation_date": "2026-04-15T12:00:00Z",
      "cancelled": true,
      "current": true,
      "last_billing_period_end_date": "2026-04-15T12:00:00Z",
      "last_billing_period_start_date": "2026-04-15T12:00:00Z",
      "name": "example",
      "plan_name": "example",
      "plan_object_name": "example",
      "previous_billing_periods": [
        {
          "closed_invoice": [
            "example"
          ],
          "end_date": "2026-04-15T12:00:00Z",
          "internal_end_date": "2026-04-15T12:00:00Z",
          "internal_start_date": "2026-04-15T12:00:00Z",
          "invoices": [
            "example"
          ],
          "pending_invoice": [
            "example"
          ],
          "start_date": "2026-04-15T12:00:00Z",
          "trial": true,
          "uid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
        }
      ],
      "start_date": "2026-04-15T12:00:00Z"
    }
  ]
}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example