AppUsageRecord
object

Choose a version:

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 section titled 'Fields'

Fields

Anchor to AppUsageRecord.createdAt createdAt DateTime! non-null: The date and time when the usage record was created.
Anchor to AppUsageRecord.description description String! non-null: The description of the app usage record.
Anchor to AppUsageRecord.id id ID! non-null: A globally-unique ID.
Anchor to AppUsageRecord.idempotencyKey idempotencyKey String: A unique key generated by the client to avoid duplicate charges.
Anchor to AppUsageRecord.price price MoneyV2! non-null: The price of the usage record.
Anchor to AppUsageRecord.subscriptionLineItem subscriptionLineItem AppSubscriptionLineItem! non-null: Defines the usage pricing plan the merchant is subscribed to.

Was this section helpful?

Anchor to section titled 'Mutations'

Mutations

Anchor to appUsageRecordCreate appUsageRecordCreate 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 cappedAmount limit that was specified in the appUsagePricingDetails field 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 a Total price exceeds balance remaining error is returned.