App
Requires The staff member must have permission to manage app billing or approve app charges if authenticated with an online access token as described in https://shopify.dev/apps/auth/oauth/access-modes.
Store usage for app subscriptions with usage pricing.
Anchor to FieldsFields
- Anchor to createdAtcreated•Date
At Time!non-null The date and time when the usage record was created.
- Anchor to descriptiondescription•String!non-null
The description of the app usage record.
- •ID!non-null
A globally-unique ID.
- Anchor to idempotencyKeyidempotency•String
Key A unique key generated by the client to avoid duplicate charges.
- Anchor to priceprice•Money
V2!non-null The price of the usage record.
- Anchor to subscriptionLineItemsubscription•App
Line Item Subscription Line Item!non-null Defines the usage pricing plan the merchant is subscribed to.
Anchor to MutationsMutations
- •mutation
Enables an app to charge a store for features or services on a per-use basis. The usage charge value is counted towards the
limit that was specified in thefield when the app subscription was created. If you create an app usage charge that causes the total usage charges in a billing interval to exceed the capped amount, then aTotal price exceeds balance remainingerror is returned.- Anchor to descriptiondescription•String!required
The description of the app usage record.
- Anchor to idempotencyKeyidempotency•String
Key A unique key generated by the client to avoid duplicate charges. Maximum length of 255 characters.
- Anchor to priceprice•Money
Input!required The price of the app usage record.
- Anchor to subscriptionLineItemIdsubscription•ID!required
Line Item Id The ID of the app subscription line item to create the usage record under. This app subscription line item must have a usage pricing plan.
Arguments
- Anchor to appUsageRecordapp•App
Usage Record Usage Record The newly created app usage record.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields