Jump to

• Request
• Response

Listing subscriptions

post

/ccstore/v1/selfservice/subscription/search

Lists the subscription header information

Request

Supported Media Types

• application/json

Body ()

Request payload to list subscription

Root Schema : subscriptionSearchRequest

Type: object

Show Source

• limit: integer
  Number of records to return.
• offset: integer
  Offset for pagination.
• q: object q
  Query criteria for filtering results.
• sort: array sort
  sorting attribute and direction of sort.

{
    "type":"object",
    "properties":{
        "q":{
            "description":"Query criteria for filtering results.",
            "type":"object",
            "properties":{
                "criteria":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "op":{
                                "description":"Comparison operator (e.g., $eq, $gt, $in, $lt).",
                                "type":"string"
                            },
                            "attribute":{
                                "description":"Attribute to filter Results(e.g Status).",
                                "type":"string"
                            },
                            "value":{
                                "description":"Attribute value to match.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "offset":{
            "description":"Offset for pagination.",
            "type":"integer"
        },
        "limit":{
            "description":"Number of records to return.",
            "type":"integer"
        },
        "sort":{
            "description":"sorting attribute and direction of sort.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "attribute":{
                        "description":"Attribute to sort the results.",
                        "type":"string",
                        "enum":[
                            "CreationDate",
                            "LastUpdateDate"
                        ]
                    },
                    "direction":{
                        "description":"Direction of sorting.",
                        "type":"string",
                        "enum":[
                            "ascending",
                            "descending"
                        ]
                    }
                }
            }
        }
    },
    "example":{
        "q":{
            "criteria":[
                {
                    "op":"$eq",
                    "attribute":"Status",
                    "value":"ORA_ACTIVE"
                }
            ]
        },
        "offset":0,
        "limit":10,
        "sort":[
            {
                "attribute":"EndDate",
                "direction":"ascending"
            }
        ]
    }
}

Example:

{
    "q":{
        "criteria":[
            {
                "op":"$eq",
                "attribute":"Status",
                "value":"ORA_ACTIVE"
            }
        ]
    },
    "offset":0,
    "limit":10,
    "sort":[
        {
            "attribute":"EndDate",
            "direction":"ascending"
        }
    ]
}

Nested Schema : q

Type: object

Query criteria for filtering results.

Show Source

• criteria: array criteria

{
    "description":"Query criteria for filtering results.",
    "type":"object",
    "properties":{
        "criteria":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "op":{
                        "description":"Comparison operator (e.g., $eq, $gt, $in, $lt).",
                        "type":"string"
                    },
                    "attribute":{
                        "description":"Attribute to filter Results(e.g Status).",
                        "type":"string"
                    },
                    "value":{
                        "description":"Attribute value to match.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : sort

Type: array

sorting attribute and direction of sort.

Show Source

• Array of: object items

{
    "description":"sorting attribute and direction of sort.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "attribute":{
                "description":"Attribute to sort the results.",
                "type":"string",
                "enum":[
                    "CreationDate",
                    "LastUpdateDate"
                ]
            },
            "direction":{
                "description":"Direction of sorting.",
                "type":"string",
                "enum":[
                    "ascending",
                    "descending"
                ]
            }
        }
    }
}

Nested Schema : criteria

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "op":{
                "description":"Comparison operator (e.g., $eq, $gt, $in, $lt).",
                "type":"string"
            },
            "attribute":{
                "description":"Attribute to filter Results(e.g Status).",
                "type":"string"
            },
            "value":{
                "description":"Attribute value to match.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• attribute: string
  Attribute to filter Results(e.g Status).
• op: string
  Comparison operator (e.g., $eq, $gt, $in, $lt).
• value: string
  Attribute value to match.

{
    "type":"object",
    "properties":{
        "op":{
            "description":"Comparison operator (e.g., $eq, $gt, $in, $lt).",
            "type":"string"
        },
        "attribute":{
            "description":"Attribute to filter Results(e.g Status).",
            "type":"string"
        },
        "value":{
            "description":"Attribute value to match.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• attribute: string
  Allowed Values: [ "CreationDate", "LastUpdateDate" ]

  Attribute to sort the results.
• direction: string
  Allowed Values: [ "ascending", "descending" ]

  Direction of sorting.

{
    "type":"object",
    "properties":{
        "attribute":{
            "description":"Attribute to sort the results.",
            "type":"string",
            "enum":[
                "CreationDate",
                "LastUpdateDate"
            ]
        },
        "direction":{
            "description":"Direction of sorting.",
            "type":"string",
            "enum":[
                "ascending",
                "descending"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful response

Body ()

Root Schema : subscriptionSearchResponse

Type: object

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array items
  The items in the collection.
• limit: integer
  The actual paging size used by the server.
• links: array links
• offset: integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included.",
            "type":"integer"
        },
        "offset":{
            "description":"The offset value used in the current page.",
            "type":"integer"
        },
        "count":{
            "description":"The number of resource instances returned in the current range.",
            "type":"integer"
        },
        "hasMore":{
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "type":"boolean"
        },
        "limit":{
            "description":"The actual paging size used by the server.",
            "type":"integer"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "items":{
            "description":"The items in the collection.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Status":{
                        "description":"The current status of the subscription product.",
                        "type":"string",
                        "enum":[
                            "ORA_ACTIVE",
                            "ORA_UNDER_AMENDMENT",
                            "ORA_EXPIRED",
                            "ORA_CANCELED"
                        ]
                    },
                    "StartDate":{
                        "format":"date",
                        "description":"The date when the subscriptions starts.",
                        "type":"string"
                    },
                    "SubscriptionId":{
                        "description":"The public unique identifier of the subscription.",
                        "type":"string"
                    },
                    "SubscriptionNumber":{
                        "description":"The public unique identifier of the subscription.",
                        "type":"string"
                    },
                    "TotalContractValue":{
                        "description":"The total contract value of the subscription",
                        "type":"string"
                    },
                    "BillToAccountId":{
                        "description":"The billing account Id identifier of the subscription",
                        "type":"string"
                    },
                    "PrimaryPartyId":{
                        "description":"The Primary partyId identifier of the subscription",
                        "type":"string"
                    },
                    "EndDate":{
                        "format":"date",
                        "description":"The date when the subscriptions starts.",
                        "type":"string"
                    },
                    "SubscriptionOwner":{
                        "description":"The owner of the subscription",
                        "type":"string"
                    },
                    "_entity":{
                        "description":"The entity name i.e Subscription",
                        "type":"string"
                    },
                    "ShortDescription":{
                        "description":"The description for the  subscription",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The items in the collection.

Show Source

• Array of: object items

{
    "description":"The items in the collection.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Status":{
                "description":"The current status of the subscription product.",
                "type":"string",
                "enum":[
                    "ORA_ACTIVE",
                    "ORA_UNDER_AMENDMENT",
                    "ORA_EXPIRED",
                    "ORA_CANCELED"
                ]
            },
            "StartDate":{
                "format":"date",
                "description":"The date when the subscriptions starts.",
                "type":"string"
            },
            "SubscriptionId":{
                "description":"The public unique identifier of the subscription.",
                "type":"string"
            },
            "SubscriptionNumber":{
                "description":"The public unique identifier of the subscription.",
                "type":"string"
            },
            "TotalContractValue":{
                "description":"The total contract value of the subscription",
                "type":"string"
            },
            "BillToAccountId":{
                "description":"The billing account Id identifier of the subscription",
                "type":"string"
            },
            "PrimaryPartyId":{
                "description":"The Primary partyId identifier of the subscription",
                "type":"string"
            },
            "EndDate":{
                "format":"date",
                "description":"The date when the subscriptions starts.",
                "type":"string"
            },
            "SubscriptionOwner":{
                "description":"The owner of the subscription",
                "type":"string"
            },
            "_entity":{
                "description":"The entity name i.e Subscription",
                "type":"string"
            },
            "ShortDescription":{
                "description":"The description for the  subscription",
                "type":"string"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : items

Type: object

Show Source

• _entity: string
  The entity name i.e Subscription
• BillToAccountId: string
  The billing account Id identifier of the subscription
• EndDate: string(date)
  The date when the subscriptions starts.
• PrimaryPartyId: string
  The Primary partyId identifier of the subscription
• ShortDescription: string
  The description for the subscription
• StartDate: string(date)
  The date when the subscriptions starts.
• Status: string
  Allowed Values: [ "ORA_ACTIVE", "ORA_UNDER_AMENDMENT", "ORA_EXPIRED", "ORA_CANCELED" ]

  The current status of the subscription product.
• SubscriptionId: string
  The public unique identifier of the subscription.
• SubscriptionNumber: string
  The public unique identifier of the subscription.
• SubscriptionOwner: string
  The owner of the subscription
• TotalContractValue: string
  The total contract value of the subscription

{
    "type":"object",
    "properties":{
        "Status":{
            "description":"The current status of the subscription product.",
            "type":"string",
            "enum":[
                "ORA_ACTIVE",
                "ORA_UNDER_AMENDMENT",
                "ORA_EXPIRED",
                "ORA_CANCELED"
            ]
        },
        "StartDate":{
            "format":"date",
            "description":"The date when the subscriptions starts.",
            "type":"string"
        },
        "SubscriptionId":{
            "description":"The public unique identifier of the subscription.",
            "type":"string"
        },
        "SubscriptionNumber":{
            "description":"The public unique identifier of the subscription.",
            "type":"string"
        },
        "TotalContractValue":{
            "description":"The total contract value of the subscription",
            "type":"string"
        },
        "BillToAccountId":{
            "description":"The billing account Id identifier of the subscription",
            "type":"string"
        },
        "PrimaryPartyId":{
            "description":"The Primary partyId identifier of the subscription",
            "type":"string"
        },
        "EndDate":{
            "format":"date",
            "description":"The date when the subscriptions starts.",
            "type":"string"
        },
        "SubscriptionOwner":{
            "description":"The owner of the subscription",
            "type":"string"
        },
        "_entity":{
            "description":"The entity name i.e Subscription",
            "type":"string"
        },
        "ShortDescription":{
            "description":"The description for the  subscription",
            "type":"string"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
  The hyperlink reference
• rel: string
  The relation of the link

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"The relation of the link",
            "type":"string"
        },
        "href":{
            "description":"The hyperlink reference",
            "type":"string"
        }
    }
}

Example Response (totalResults)

1056

Example Response (offset)

0

Example Response (count)

10

Example Response (hasMore)

true

Example Response (limit)

10

Example Response (links)

[
    {
        "rel":"self",
        "href":"http://localhost:8080/ccstore/v1/selfservice/subscription/search"
    },
    {
        "rel":"next",
        "href":"http://localhost:8080/ccstore/v1/selfservice/subscription/search?offset=10&limit=10"
    }
]

Example Response (items)

[
    {
        "StartDate":"2025-05-16T00:00:00.000+0000",
        "Status":"ORA_ACTIVE",
        "SubscriptionId":"300100633967156",
        "SubscriptionNumber":"CDRM_30233",
        "TotalContractValue":"450",
        "Status_localizedValue":"Active",
        "BillToAccountId":1006,
        "PrimaryPartyId":1006,
        "EndDate":"2025-06-15T00:00:00.000+0000",
        "SubscriptionOwner":"ABCPatric",
        "_entity":"Subscription",
        "ShortDescription":null
    },
    {
        "StartDate":"2025-05-19T00:00:00.000+0000",
        "Status":"ORA_ACTIVE",
        "SubscriptionId":"300100634026183",
        "SubscriptionNumber":"CDRM_31051",
        "TotalContractValue":"0",
        "Status_localizedValue":"Active",
        "BillToAccountId":1006,
        "PrimaryPartyId":1006,
        "EndDate":"2025-06-18T00:00:00.000+0000",
        "SubscriptionOwner":"ABCPatric",
        "_entity":"Subscription",
        "ShortDescription":null
    },
    {
        "StartDate":"2025-05-20T00:00:00.000+0000",
        "Status":"ORA_ACTIVE",
        "SubscriptionId":"300100634018036",
        "SubscriptionNumber":"CDRM_30250",
        "TotalContractValue":"450",
        "Status_localizedValue":"Active",
        "BillToAccountId":1006,
        "PrimaryPartyId":1006,
        "EndDate":"2025-06-19T00:00:00.000+0000",
        "SubscriptionOwner":"ABCPatric",
        "_entity":"Subscription",
        "ShortDescription":null
    },
    {
        "StartDate":"2025-05-20T00:00:00.000+0000",
        "Status":"ORA_ACTIVE",
        "SubscriptionId":"300100634037270",
        "SubscriptionNumber":"CDRM_31068",
        "TotalContractValue":"0",
        "Status_localizedValue":"Active",
        "BillToAccountId":1006,
        "PrimaryPartyId":1006,
        "EndDate":"2025-06-19T00:00:00.000+0000",
        "SubscriptionOwner":"ABCPatric",
        "_entity":"Subscription",
        "ShortDescription":null
    },
    {
        "StartDate":"2025-05-26T00:00:00.000+0000",
        "Status":"ORA_ACTIVE",
        "SubscriptionId":"300100634151544",
        "SubscriptionNumber":"CDRM_37049",
        "TotalContractValue":"100",
        "Status_localizedValue":"Active",
        "BillToAccountId":1006,
        "PrimaryPartyId":1006,
        "EndDate":"2025-06-25T00:00:00.000+0000",
        "SubscriptionOwner":"ABCPatric",
        "_entity":"Subscription",
        "ShortDescription":null
    },
    {
        "StartDate":"2025-06-02T00:00:00.000+0000",
        "Status":"ORA_ACTIVE",
        "SubscriptionId":"300100634204312",
        "SubscriptionNumber":"CDRM_40047",
        "TotalContractValue":"1000",
        "Status_localizedValue":"Active",
        "BillToAccountId":1006,
        "PrimaryPartyId":1006,
        "EndDate":"2025-07-01T00:00:00.000+0000",
        "SubscriptionOwner":"ABCPatric",
        "_entity":"Subscription",
        "ShortDescription":null
    },
    {
        "StartDate":"2025-06-04T00:00:00.000+0000",
        "Status":"ORA_ACTIVE",
        "SubscriptionId":"300100634175364",
        "SubscriptionNumber":"CDRM_38048",
        "TotalContractValue":"0",
        "Status_localizedValue":"Active",
        "BillToAccountId":1006,
        "PrimaryPartyId":1006,
        "EndDate":"2025-07-03T00:00:00.000+0000",
        "SubscriptionOwner":"ABCPatric",
        "_entity":"Subscription",
        "ShortDescription":null
    },
    {
        "StartDate":"2025-06-04T00:00:00.000+0000",
        "Status":"ORA_ACTIVE",
        "SubscriptionId":"300100634181611",
        "SubscriptionNumber":"CDRM_38049",
        "TotalContractValue":"0",
        "Status_localizedValue":"Active",
        "BillToAccountId":1006,
        "PrimaryPartyId":1006,
        "EndDate":"2025-07-03T00:00:00.000+0000",
        "SubscriptionOwner":"ABCPatric",
        "_entity":"Subscription",
        "ShortDescription":null
    },
    {
        "StartDate":"2025-06-26T00:00:00.000+0000",
        "Status":"ORA_ACTIVE",
        "SubscriptionId":"300100634580922",
        "SubscriptionNumber":"CDRM_46081",
        "TotalContractValue":"300",
        "Status_localizedValue":"Active",
        "BillToAccountId":1006,
        "PrimaryPartyId":1006,
        "EndDate":"2025-07-15T00:00:00.000+0000",
        "SubscriptionOwner":"ABCPatric",
        "_entity":"Subscription",
        "ShortDescription":null
    },
    {
        "StartDate":"2025-06-21T00:00:00.000+0000",
        "Status":"ORA_ACTIVE",
        "SubscriptionId":"300100634542726",
        "SubscriptionNumber":"CDRM_46063",
        "TotalContractValue":"200",
        "Status_localizedValue":"Active",
        "BillToAccountId":1006,
        "PrimaryPartyId":1006,
        "EndDate":"2025-07-20T00:00:00.000+0000",
        "SubscriptionOwner":"ABCPatric",
        "_entity":"Subscription",
        "ShortDescription":null
    }
]

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• message: string
  The error message
• status: string
  The Error code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The error message",
            "type":"string"
        },
        "status":{
            "description":"The Error code",
            "type":"string"
        }
    }
}

500 Response

Internal server error

Body ()

Root Schema : Error

Type: object

Show Source

• message: string
  The error message
• status: string
  The Error code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The error message",
            "type":"string"
        },
        "status":{
            "description":"The Error code",
            "type":"string"
        }
    }
}

Back to Top