appUsageRecordCreate mutation

Allows an app to charge a store for usage.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation appUsageRecordCreate($subscriptionLineItemId: ID!, $price: MoneyInput!, $description: String!) { appUsageRecordCreate(subscriptionLineItemId: $subscriptionLineItemId, price: $price, description: $description) { 
  1. <font style="color:#1F61A0;">appUsageRecord</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">field</font>
  11.   <font style="color:#1F61A0;">message</font>
  13. <font style="color:#555555;">}</font>
} } { “subscriptionLineItemId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “price”: { 
  1. <font style="color:#8B2BB9;">"amount"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  3. <font style="color:#8B2BB9;">"currencyCode"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>
}, “description”: “placeholder” }

Arguments

Argument Description
description
(
[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

) REQUIRED		 The description of the app usage record.
price
(
[MoneyInput!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyinput)

) REQUIRED		 The price of the app usage record. The only permitted currceny code is USD.
subscriptionLineItemId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID for the app subscription line item.

MoneyInput fields

  • amount ([Decimal!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#decimal-2021-01)) REQUIRED
    Decimal money amount.
  • currencyCode ([CurrencyCode!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/currencycode)) REQUIRED
    Currency of the money.

Return fields

  • appUsageRecord ([AppUsageRecord](https://shopify.dev/docs/admin-api/graphql/reference/billing/appusagerecord))
    The newly created app usage record.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.