Skip to main content
object

Requires read_store_credit_accounts access scope.

A store credit account contains a monetary balance that can be redeemed at checkout for purchases in the shop. The account is held in the specified currency and has an owner that cannot be transferred.

The account balance is redeemable at checkout only when the owner is authenticated via new customer accounts authentication.

•MoneyV2!
non-null

The current balance of the store credit account.

•ID!
non-null

A globally-unique ID.

•HasStoreCreditAccounts!
non-null

The owner of the store credit account.

•StoreCreditAccountTransactionConnection!
non-null

The transaction history of the store credit account.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

nametypedescriptionacceptable_valuesdefault_valueexample_use
expires_attimeFilter transactions by expiry date. Only applicable to
StoreCreditAccountCreditTransaction objects. All other objects are handled
as if they have a null expiry date.-
expires_at:<='2025-01-01T00:00:00+01:00'
-
expires_at:<='2025-12-31T23:00:00Z'
ididFilter by id range.- id:1234
- id:>=1234
- id:<=1234
typestringFilter transactions by type. Any value other than the
accepted values will be ignored.- credit
- debit
-
debit_revert
- expiration
- type:expiration
-
type:credit OR type:debit_revert
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).
•Boolean
Default:false

Reverse the order of the underlying list.

•TransactionSortKeys
Default:CREATED_AT

Sort the underlying list by the given key.



Was this section helpful?

•query

Retrieves a StoreCreditAccount by ID. Store credit accounts hold monetary balances that account owners can use at checkout. The owner is either a Customer or a CompanyLocation.

Arguments

•ID!
required

The ID of the store credit account to return.



Was this section helpful?

•interface

Was this section helpful?