Get Subscriptions

Get the subscriptions for an organization order by creation date desc

Returns the subscriptions related with an organization

Request

URI

GET

https://api.app-catalog.vmware.com/v1/subscriptions

COPY

Query Parameters

SubscriptionStatus

status

Optional

It filters the subscriptions by the status

status example

ACTIVE

string

order_field

Optional

Constraints: default: CREATED_AT

Name of the field to order the subscription requests: CREATED_AT (default), ID, ORGANIZATION_NAME, ORGANIZATION_ID, PRODUCT_ID, SUBSCRIPTION_STATUS, ACTIVE_AT, STARTS_AT, ENDS_AT

order_field example

CREATED_AT

string

order_direction

Optional

Constraints: default: DESC

Order to sort by the selected field: ASC or DESC (default)

integer

page

Optional

Constraints: minimum: 1 default: 1

An integer that identifies the page number for a paged response

integer

page_size

Optional

Constraints: minimum: 1 maximum: 100 default: 20

An integer that identifies the maximum page size for a paged response

Authentication

This operation uses the following authentication methods.

BearerAuth

Responses

200

Paginated list of subscriptions

Returns SubscriptionsPage of type(s) application/json

This response body class contains all of the following: InlineSubscriptionsPage0 , InlineSubscriptionsPage1

{
    "page": 1,
    "page_size": 5,
    "total_size": 10,
    "total_pages": 2,
    "items": [
        {
            "id": "aa6ce24d-b38a-405b-a1ca-3ac0a79418bb",
            "product_id": "VTAC_AAORG_CP",
            "status": "ACTIVE",
            "quotas": {
                "applications": {
                    "limit": 25
                }
            },
            "created_at": "2023-03-03T00:59:52.762Z",
            "created_by": "Bitnami Secure Images",
            "updated_at": "2023-03-03T00:59:52.762Z",
            "updated_by": "Bitnami Secure Images",
            "starts_at": "2023-03-03T00:59:52.762Z",
            "ends_at": "2023-03-03T00:59:52.762Z"
        }
    ]
}

403

The requesting user is not authorized to get subscriptions

Returns Error403 of type(s) application/problem+json

This response body class contains all of the following: InlineError4030

{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

500

An internal server error object

Returns Error500 of type(s) application/problem+json

This response body class contains all of the following: InlineError5000

{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

503

The server is temporarily unavailable

Returns Error503 of type(s) application/problem+json

This response body class contains all of the following: InlineError5030

{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/v1/subscriptions

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Subscriptions Operations