API version 2021-01 Release candidate
API version 2020-10 Latest
API version 2020-07
API version 2020-04
API version 2020-01
API version 2019-10 Unsupported
API version 2019-07 Unsupported

appUsageRecordCreate mutation

Version 2021-01 (Release candidate)

Allows an app to charge a store for usage.

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.


Arguments

description ( String! ) required

The description of the app usage record.

price ( MoneyInput! ) required

The price of the app usage record. The only permitted currceny code is USD.

subscriptionLineItemId ( ID! ) required

The ID for the app subscription line item.

MoneyInput fields

amount (Decimal!) Required

Decimal money amount.

currencyCode (CurrencyCode!) Required

Currency of the money.

Return fields

appUsageRecord (AppUsageRecord)

The newly created app usage record.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-10 (Latest)

Allows an app to charge a store for usage.

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.


Arguments

description ( String! ) required

The description of the app usage record.

price ( MoneyInput! ) required

The price of the app usage record. The only permitted currceny code is USD.

subscriptionLineItemId ( ID! ) required

The ID for the app subscription line item.

MoneyInput fields

amount (Decimal!) Required

Decimal money amount.

currencyCode (CurrencyCode!) Required

Currency of the money.

Return fields

appUsageRecord (AppUsageRecord)

The newly created app usage record.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-07

Allows an app to charge a store for usage.

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.


Arguments

description ( String! ) required

The description of the app usage record.

price ( MoneyInput! ) required

The price of the app usage record. The only permitted currceny code is USD.

subscriptionLineItemId ( ID! ) required

The ID for the app subscription line item.

MoneyInput fields

amount (Decimal!) Required

Decimal money amount.

currencyCode (CurrencyCode!) Required

Currency of the money.

Return fields

appUsageRecord (AppUsageRecord)

The newly created app usage record.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-04

Allows an app to charge a store for usage.

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.


Arguments

description ( String! ) required

The description of the app usage record.

price ( MoneyInput! ) required

The price of the app usage record. The only permitted currceny code is USD.

subscriptionLineItemId ( ID! ) required

The ID for the app subscription line item.

MoneyInput fields

amount (Decimal!) Required

Decimal money amount.

currencyCode (CurrencyCode!) Required

Currency of the money.

Return fields

appUsageRecord (AppUsageRecord)

The newly created app usage record.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-01

Allows an app to charge a store for usage.

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.


Arguments

description ( String! ) required

The description of the app usage record.

price ( MoneyInput! ) required

The price of the app usage record. The only permitted currceny code is USD.

subscriptionLineItemId ( ID! ) required

The ID for the app subscription line item.

MoneyInput fields

amount (Decimal!) Required

Decimal money amount.

currencyCode (CurrencyCode!) Required

Currency of the money.

Return fields

appUsageRecord (AppUsageRecord)

The newly created app usage record.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Allows an app to charge a store for usage.

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.


Arguments

description ( String! ) required

The description of the app usage record.

price ( MoneyInput! ) required

The price of the app usage record. The only permitted currceny code is USD.

subscriptionLineItemId ( ID! ) required

The ID for the app subscription line item.

MoneyInput fields

amount (Decimal!) Required

Decimal money amount.

currencyCode (CurrencyCode!) Required

Currency of the money.

Return fields

appUsageRecord (AppUsageRecord)

The newly created app usage record.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Allows an app to charge a store for usage.

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.


Arguments

description ( String! ) required

The description of the app usage record.

price ( MoneyInput! ) required

The price of the app usage record. The only permitted currceny code is USD.

subscriptionLineItemId ( ID! ) required

The ID for the app subscription line item.

MoneyInput fields

amount (Decimal!) Required

Decimal money amount.

currencyCode (CurrencyCode!) Required

Currency of the money.

Return fields

appUsageRecord (AppUsageRecord)

The newly created app usage record.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.