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

appPurchaseOneTimeCreate mutation

Version unstable

Allows an app to charge a shop for features or services one time.

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

Argument Description
name ( String! ) required

The name of the app one-time purchase.
price ( MoneyInput! ) required

The amount to be charged to the store for the app one-time purchase. The only permitted currency code is USD.
returnUrl ( URL! ) required

The URL where the merchant is redirected after approving the app one-time purchase.
test ( Boolean )

Specifies whether the app one-time purchase is a test transaction.
Default value: false

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appPurchaseOneTime (AppPurchaseOneTime)

    The newly created app one-time purchase.

  • confirmationUrl (URL)

    The URL where the merchant can approve or decline the app one-time purchase.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Release candidate)

Allows an app to charge a shop for features or services one time.

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

Argument Description
name ( String! ) required

The name of the app one-time purchase.
price ( MoneyInput! ) required

The amount to be charged to the store for the app one-time purchase. The only permitted currency code is USD.
returnUrl ( URL! ) required

The URL where the merchant is redirected after approving the app one-time purchase.
test ( Boolean )

Specifies whether the app one-time purchase is a test transaction.
Default value: false

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appPurchaseOneTime (AppPurchaseOneTime)

    The newly created app one-time purchase.

  • confirmationUrl (URL)

    The URL where the merchant can approve or decline the app one-time purchase.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01 (Latest)

Allows an app to charge a shop for features or services one time.

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

Argument Description
name ( String! ) required

The name of the app one-time purchase.
price ( MoneyInput! ) required

The amount to be charged to the store for the app one-time purchase. The only permitted currency code is USD.
returnUrl ( URL! ) required

The URL where the merchant is redirected after approving the app one-time purchase.
test ( Boolean )

Specifies whether the app one-time purchase is a test transaction.
Default value: false

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appPurchaseOneTime (AppPurchaseOneTime)

    The newly created app one-time purchase.

  • confirmationUrl (URL)

    The URL where the merchant can approve or decline the app one-time purchase.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

Allows an app to charge a shop for features or services one time.

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

Argument Description
name ( String! ) required

The name of the app one-time purchase.
price ( MoneyInput! ) required

The amount to be charged to the store for the app one-time purchase. The only permitted currency code is USD.
returnUrl ( URL! ) required

The URL where the merchant is redirected after approving the app one-time purchase.
test ( Boolean )

Specifies whether the app one-time purchase is a test transaction.
Default value: false

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appPurchaseOneTime (AppPurchaseOneTime)

    The newly created app one-time purchase.

  • confirmationUrl (URL)

    The URL where the merchant can approve or decline the app one-time purchase.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-07

Allows an app to charge a shop for features or services one time.

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

Argument Description
name ( String! ) required

The name of the app one-time purchase.
price ( MoneyInput! ) required

The amount to be charged to the store for the app one-time purchase. The only permitted currency code is USD.
returnUrl ( URL! ) required

The URL where the merchant is redirected after approving the app one-time purchase.
test ( Boolean )

Specifies whether the app one-time purchase is a test transaction.
Default value: false

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appPurchaseOneTime (AppPurchaseOneTime)

    The newly created app one-time purchase.

  • confirmationUrl (URL)

    The URL where the merchant can approve or decline the app one-time purchase.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-04

Allows an app to charge a shop for features or services one time.

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

Argument Description
name ( String! ) required

The name of the app one-time purchase.
price ( MoneyInput! ) required

The amount to be charged to the store for the app one-time purchase. The only permitted currency code is USD.
returnUrl ( URL! ) required

The URL where the merchant is redirected after approving the app one-time purchase.
test ( Boolean )

Specifies whether the app one-time purchase is a test transaction.
Default value: false

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appPurchaseOneTime (AppPurchaseOneTime)

    The newly created app one-time purchase.

  • confirmationUrl (URL)

    The URL where the merchant can approve or decline the app one-time purchase.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-01 (Unsupported)

Allows an app to charge a shop for features or services one time.

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

Argument Description
name ( String! ) required

The name of the app one-time purchase.
price ( MoneyInput! ) required

The amount to be charged to the store for the app one-time purchase. The only permitted currency code is USD.
returnUrl ( URL! ) required

The URL where the merchant is redirected after approving the app one-time purchase.
test ( Boolean )

Specifies whether the app one-time purchase is a test transaction.
Default value: false

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appPurchaseOneTime (AppPurchaseOneTime)

    The newly created app one-time purchase.

  • confirmationUrl (URL)

    The URL where the merchant can approve or decline the app one-time purchase.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Allows an app to charge a shop for features or services one time.

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

Argument Description
name ( String! ) required

The name of the app one-time purchase.
price ( MoneyInput! ) required

The amount to be charged to the store for the app one-time purchase. The only permitted currency code is USD.
returnUrl ( URL! ) required

The URL where the merchant is redirected after approving the app one-time purchase.
test ( Boolean )

Specifies whether the app one-time purchase is a test transaction.
Default value: false

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appPurchaseOneTime (AppPurchaseOneTime)

    The newly created app one-time purchase.

  • confirmationUrl (URL)

    The URL where the merchant can approve or decline the app one-time purchase.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Allows an app to charge a shop for features or services one time.

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

Argument Description
name ( String! ) required

The name of the app one-time purchase.
price ( MoneyInput! ) required

The amount to be charged to the store for the app one-time purchase. The only permitted currency code is USD.
returnUrl ( URL! ) required

The URL where the merchant is redirected after approving the app one-time purchase.
test ( Boolean )

Specifies whether the app one-time purchase is a test transaction.
Default value: false

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appPurchaseOneTime (AppPurchaseOneTime)

    The newly created app one-time purchase.

  • confirmationUrl (URL)

    The URL where the merchant can approve or decline the app one-time purchase.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Allows an app to charge a shop for features or services one time.

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

Argument Description
name ( String! ) required

The name of the app one-time purchase.
price ( MoneyInput! ) required

The amount to be charged to the store for the app one-time purchase. The only permitted currency code is USD.
returnUrl ( URL! ) required

The URL where the merchant is redirected after approving the app one-time purchase.
test ( Boolean )

Specifies whether the app one-time purchase is a test transaction.
Default value: false

MoneyInput fields

  • amount (Decimal!) Required

    Decimal money amount.

  • currencyCode (CurrencyCode!) Required

    Currency of the money.

Return fields

  • appPurchaseOneTime (AppPurchaseOneTime)

    The newly created app one-time purchase.

  • confirmationUrl (URL)

    The URL where the merchant can approve or decline the app one-time purchase.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.