Choose a version:

AppUsageRecord

object

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 createdAtcreatedAt •DateTime! 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.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to idempotencyKeyidempotencyKey •String: A unique key generated by the client to avoid duplicate charges.
Anchor to priceprice •MoneyV2! non-null: The price of the usage record.
Anchor to subscriptionLineItemsubscriptionLineItem •AppSubscriptionLineItem! non-null: Defines the usage pricing plan the merchant is subscribed to.

Was this section helpful?

Anchor to MutationsMutations

Anchor to appUsageRecordCreate appUsageRecordCreate

•mutation

Creates a usage charge for an app subscription with usage-based pricing. The charge counts toward the capped amount limit set when creating the subscription.

Usage records track consumption of app features or services on a per-use basis. You provide the charge amount, a description of what you consumed, and the subscription line item ID. The optional idempotencyKey parameter prevents duplicate charges if you send the same request multiple times.

If the new charge would cause total usage charges in the current billing interval to exceed the capped amount, then the mutation returns an error.

Learn more about creating usage-based subscriptions.