Inputs
Inputs are used as arguments for your mutation operations. They are a type of object which define a set of fields, which in turn can either be Scalars, Enums, or other input objects.
CreateUserInput
Fields
Name | Type | String |
---|---|---|
id | The id which you want to assign to identify the user. | |
billingId | The id of the user which identifies them to be charged for their subscriptions. This will often be the id given by your payment provider (ie. Stripe, Chargebee, etc). | |
name | The name of the user. | |
The email of the user. | ||
metadata |
UpdateUserInput
How can I update the email or billingId of a user?
You will need to do this through a CSV Import within our Dashboard. We'll soon make this possible through the API.
Fields
Name | Type | String |
---|---|---|
id | The new id which you want to assign to identify the user. | |
name | The name of the user. | |
metadata |
CreateUsageEventInput
Fields
userId | ||
featureId | ||
delta | ||
action | Specify how you want the usage of the feature to be recorded. Can be |
CreateFeatureInput
Fields
Name | Type | String |
---|---|---|
id | The id which you want to assign to identify the feature. | |
name | The name of the feature. | |
type | The type of the feature. Either | |
unitLabel | The name of the consumable unit (eg. Message, API Call, etc). Only necessary if | |
unitLabelPlural | The pluralised name of the consumable unit (eg. Messages, API Calls, etc). Only necessary if | |
metadata |
UpdateFeatureInput
How do I update the type of feature?
It is not possible to update the type of feature once it has been initially set. You would need to create a new feature altogether.
Fields
Name | Type | String |
---|---|---|
name | The name of the feature. | |
unitLabel | The name of the consumable unit (eg. Message, API Call, etc). Only necessary if | |
unitLabelPlural | The pluralised name of the consumable unit (eg. Messages, API Calls, etc). Only necessary if | |
metadata |
CreatePackageInput
How do I add prices to my packages and/or features within?
You will currently need to use the Dashboard to add any billing templates and prices to packages and respective features within. We are currently looking into how to best achieve this through the API.
Fields
Name | Type | String |
---|---|---|
id | The id which you want to assign to identify the package. | |
name | The name of the package. | |
isAddon | Represents whether the package is an add-on ( | |
features | A list of the features which will be added to the package. | |
metadata |
CreatePackageFeatureInput
Fields
Name | Type | String |
---|---|---|
id | ||
entitlement | The entitlement which a user would have for this consumable feature. Only necessary if the feature has a |
EntitlementInput
Fields
Name | Type | String |
---|---|---|
limit | Indicates the amount of the feature given to the user (ie. | |
resetPeriod | Indicates the period by which the limit will reset (ie. | |
overageEnabled | Flags whether a user can run over the limit ( |
UpdatePackageInput
For larger changes beyond adding metadata, you should use the Dashboard to update existing packages. We are currently looking into how to best achieve this through the API.
Fields
Name | Type | String |
---|---|---|
metadata |
Last updated