Waiting for engine...
Skip to main content

deployedApiSubscription

Returns the Subscription for the Deployed API that matches the specified API Key ID.

Input Parameters:

  • apiKeyId: API Key ID of the subscription to retrieve.

Response: DeployedApiSubscription object with complete subscription details including API, application, and plan information.

Example Request:

query {
deployedApiSubscription(apiKeyId: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>") {
apiKeyId,
status,
startDate,
expirationDate,
approvalDate,
consumerMessage,
producerMessage,
deployedApi {
id,
version,
component {
id,
name
}
},
application {
id,
name,
ownerName
},
plan {
id,
name,
rateLimit
}
}
}

deployedApiSubscription(
apiKeyId: ID!
): DeployedApiSubscription!

Arguments

deployedApiSubscription.apiKeyId ● ID! non-null scalar miscellaneous

Type

DeployedApiSubscription object platform

On this Page