Get Paged Subscriptions V4 Using GET

Get Paged Subscriptions V4 Using GET

Retrieve a list of subscriptions by some criteria.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Owner ✔️ ✔️
Billing Read-only ✔️ ✔️
Request
URI
GET
https://{api_host}/csp/gateway/commerce/api/v4/subscriptions
COPY
Query Parameters
string
serviceDefinitionId
Optional

This or billingAccountId or orgId is required

string
billingAccountId
Optional

This or serviceDefinitionId or orgId is required

string
orgId
Optional

This or serviceDefinitionId or billingAccountId is required

string
serialNumber
Optional

The GTO serial number

integer
pageStart
Optional
Constraints: default: 1

pageStart

integer
pageLimit
Optional
Constraints: default: 10

Default value is 10, maximum is 10

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PagedResponseV4SubscriptionResponse of type(s) application/json 
{
    "nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15",
    "prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
    "results": [
        {
            "billingAccountId": "db36fc9b-6fde-4f10-8f32-2b2524a574fc",
            "billingEngineSubscriptionId": "M123445678",
            "lastUpdateDateTime": "2024-01-30T00:05:01.194Z",
            "orgId": "485a55fc-b853-40ee-b869-a1b2988e509c",
            "quantity": "500",
            "serialNumber": "52331152-1-1",
            "serviceDefinitionId": "d27a99af-f433-4427-a58a-acdc01c9e3f8",
            "serviceEndDate": "2024-12-25",
            "serviceStartDate": "2024-01-25",
            "sku": "TBD",
            "status": "ACTIVE",
            "subscriptionId": "f9971a9e-de15-4abb-a732-a24bfa3378a6",
            "subscriptionType": "PAID",
            "v3BillingModel": "string",
            "v3ChargeId": "VOD-HS",
            "v3Datacenter": "A1",
            "v3SubscriptionId": "f9971a9e-de15-4abb-a732-a24bfa3378a6",
            "v3SubscriptionType": "string"
        }
    ],
    "totalResults": 2000
}
string
nextLink
Optional

Relative path to next page if exists. Not returned for POST requests.

string
prevLink
Optional

Relative path to previous page if exists. Not returned for POST requests.

array of object
results
Optional

Partial list of returned results.

integer As int32 As int32
totalResults
Optional

Total number of results if available.


401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


404

Request error, see error code for details

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


500

Unexpected error

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/commerce/api/v4/subscriptions
On This Page
Subscriptions V4 Operations
GET
Get Paged Subscriptions V4 Using GET
GET
Get Subscription V4 Using GET