Waiting for engine...
Skip to main content

deployedApiSubscriptionCreate

Creates a Subscription. Deployed API's ID, Application ID and Plan ID are mandatory fields.

Input Parameters:

  • deployedApiSubscription: Subscription configuration including deployed API ID, application ID, plan ID, and dates.

Response:

  • Returns the created DeployedApiSubscription object with API key and complete subscription details.

Example Request:

mutation deployedApiSubscriptionCreate($deployedApiSubscription: DeployedApiSubscriptionCreateInput!) {
deployedApiSubscriptionCreate(
deployedApiSubscription: $deployedApiSubscription
) {
apiKeyId,
status,
startDate,
expirationDate,
approvalDate,
consumerMessage,
producerMessage,
generatedBy,
generatedDate,
statusChangedBy,
statusChangedDate
}
}

Variables:

{
"deployedApiSubscription": {
"deployedApiId": "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
"applicationId": "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
"planId": "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
"expirationDate": "2021-11-30T11:31:45"
}
}

deployedApiSubscriptionCreate(
deployedApiSubscription: DeployedApiSubscriptionCreateInput!
): DeployedApiSubscription!

Arguments

deployedApiSubscriptionCreate.deployedApiSubscription ● DeployedApiSubscriptionCreateInput! non-null input platform

Type

DeployedApiSubscription object platform

On this Page