mutation
before the field(s).
Name | Type | Description |
---|---|---|
input | CreateFeatureInput! | The input needed to create the feature. See Inputs for more. |
Name | Type | Description |
---|---|---|
data | Feature! | The Feature which was created. |
errors / error | See Errors | Returns any errors which may have occurred with the request. |
Name | Type | Description |
---|---|---|
input | UpdateFeatureInput! | The input needed to update the feature. See Inputs for more. |
Name | Type | Description |
---|---|---|
data | Feature! | The Feature which was updated. |
errors / error | See Errors | Returns any errors which may have occurred with the request. |
Name | Type | Description |
---|---|---|
input | CreatePackageInput! | The input needed to create the package. See Inputs for more. |
Name | Type | Description |
---|---|---|
data | Package! | The Package which was created. |
errors / error | See Errors | Returns any errors which may have occurred with the request. |
metadata
can be updated on the Package object through the API. All other updates will need to be done through the Dashboard. Let us know if you want to see further updatable fields and your use-cases!Name | Type | Description |
---|---|---|
input | UpdatePackageInput! | The input needed to update the package. See Inputs for more. |
Name | Type | Description |
---|---|---|
data | Package! | The Package which was updated. |
errors / error | See Errors | Returns any errors which may have occurred with the request. |
Name | Type | Description |
---|---|---|
input | CreateUserInput! | The input needed to create the user. See Inputs for more. |
Name | Type | Description |
---|---|---|
data | User! | The User which was created. |
errors / error | See Errors | Returns any errors which may have occurred with the request. |
Name | Type | Description |
---|---|---|
input | UpdateUserInput! | The input needed to update the user. See Inputs for more. |
Name | Type | Description |
---|---|---|
data | User! | The User which was updated. |
errors / error | See Errors | Returns any errors which may have occurred with the request. |
PUBLISHED
.
Name | Type | Description |
---|---|---|
packageIds | [String!]! | An array of id’s for the packages which the user is to be subscribed to. These are the id fields of aPackage. |
userId | String! | The identifier of the user to subscribe the package(s) to. This maps to the id field as set on the User object. |
Name | Type | Description |
---|---|---|
data | [Subscription]! | An array of subscriptions to the packages which the user in question has just been subscribed to. |
errors / error | See Errors | Returns any errors which may have occurred with the request. |
Cannot subscribe to addon
Cannot subscribe to multiple tiers
isAddon
field for the Package object will be false
if it’s a base plan. You can check Packages with the packages query.Package Id not found for app
delta
argument (ie. -1
).Name | Type | Description |
---|---|---|
input | CreateUsageEventInput! | The input needed to record the usage event. See Inputs for more. |
Name | Type | Description |
---|---|---|
data | RecordedUsage | An object containing information on whether the usage of the feature was recorded or not (recorded boolean and reason ). |
errors / error | See Errors | Returns any errors which may have occurred with the request. |
templateId
- otherwise aSubscriptionLinkError
error will be
returned.Name | Type | Description |
---|---|---|
userId | String | The identifier of the user who will be subscribing. This maps to the id field as set on the User object. Your billing provider will otherwise create this user in Kana for you if you don’t have an identifier available. |
templateId | String! | The identifier of the billing template which is related to the package and price which you want to subscribe the user to. |
successUrl | String! | The URL which you want to redirect users to upon successful payment to subscribe. |
cancelUrl | String! | The URL which you want to redirect users to upon a cancelled payment to subscribe. |
Name | Type | Description |
---|---|---|
data | SubscriptionLink! | An object containing the generated URL (url ) which a user can navigate to in order to pay and subscribe to a package. |
errors / error | See Errors | Returns any errors which may have occurred with the request. |
Name | Type | Description |
---|---|---|
userId | String! | The id of the User who you want to generate the token for. |
Name | Type | Description |
---|---|---|
data | GeneratedUserToken | An object containing the token which can be used to authenticate a user with the Client SDK. |
errors / error | See Errors | Returns any errors which may have occurred with the request. |