Get Subscription

Get Subscription

Returns the a subscription belonging to the user's org

Request
URI
GET
https://{api_host}/v1/subscriptions/{subscription_id}
COPY
Path Parameters
subscription_id
Required

String identifier of the subscription


Authentication
This operation uses the following authentication methods.
Responses
200

The subscription

Returns Subscription of type(s) application/json
"Subscription Object"
string
id
Optional

Identifier of the subscription in CSP. Old subscriptions might have no CSP id.

string
product_id
Required

Name of the product of the subscription

string
status
Required

Status of the subscription (ACTIVE, CREATED, EXPIRED, TERMINATED, ERROR, SUBMITTED, PENDING_EXPIRY, SUSPENDED)

object
quotas
Optional

Quotas for this subscription

string As date-time As date-time
created_at
Required

Date of the creation of the subscription

string As date-time As date-time
updated_at
Optional

Date of the update of the subscription

string As date-time As date-time
starts_at
Optional

Date of the start of the subscription

string As date-time As date-time
ends_at
Optional

Date of the end of the subscription


403

The requesting user is not authorized to get a subscription

Returns Error403 of type(s) application/problem+json
This response body class contains all of the following: InlineError4030
"Error403 Object"

404

The subscription is not found

Returns Error404 of type(s) application/problem+json
This response body class contains all of the following: InlineError4040
"Error404 Object"

500

An internal server error object

Returns Error500 of type(s) application/problem+json
This response body class contains all of the following: InlineError5000
"Error500 Object"

503

The server is temporarily unavailable

Returns Error503 of type(s) application/problem+json
This response body class contains all of the following: InlineError5030
"Error503 Object"

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