Waiting for engine...
Skip to main content

deployedApiSubscriptionDelete

Deletes an existing Subscription using it's API Key ID.

Input Parameters:

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

Response:

  • Returns the ID of the deleted subscription.

Example Request:

mutation deployedApiSubscriptionDelete($apiKeyId: ID!) {
deployedApiSubscriptionDelete(apiKeyId: $apiKeyId)
}

Variables:

{
"apiKeyId": "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>"
}

Sample Response:

{
"data": {
"deployedApiSubscriptionDelete": "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>"
}
}

deployedApiSubscriptionDelete(
apiKeyId: ID!
): ID!

Arguments

deployedApiSubscriptionDelete.apiKeyId ● ID! non-null scalar miscellaneous

Type

ID scalar miscellaneous

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

On this Page