Waiting for engine...
Skip to main content

DeployedApiSubscriptionCreateInput

Input parameters for creating a new API subscription.

input DeployedApiSubscriptionCreateInput {
deployedApiId: String!
applicationId: String!
planId: String!
startDate: DateTime
expirationDate: DateTime
}

Fields

DeployedApiSubscriptionCreateInput.deployedApiId ● String! non-null scalar miscellaneous

The Deployed API ID for which Subscription is requested

DeployedApiSubscriptionCreateInput.applicationId ● String! non-null scalar miscellaneous

The Application ID for which Subscription is requested

DeployedApiSubscriptionCreateInput.planId ● String! non-null scalar miscellaneous

The Plan ID of the API for which Subscription is requested

DeployedApiSubscriptionCreateInput.startDate ● DateTime scalar partner-portal

The date from which Subscription should be active. Value can be either a number corresponding to the date in milliseconds or in the format YYYY-MM-DDThh:mm. If this field is omitted, Subscription will become active from the time of creation.

DeployedApiSubscriptionCreateInput.expirationDate ● DateTime scalar partner-portal

The date till which Subscription should be active. Value can be either a number corresponding to the date in milliseconds or in the format YYYY-MM-DDThh:mm. If this field is omitted, Subscription will not have an expiration date.

Member Of

deployedApiSubscriptionCreate mutation

On this Page