--- title: storeCreditAccount - GraphQL Admin description: Returns a store credit account resource by ID. api_version: 2024-10 api_name: admin type: query api_type: graphql source_url: html: >- https://shopify.dev/docs/api/admin-graphql/2024-10/queries/storeCreditAccount md: >- https://shopify.dev/docs/api/admin-graphql/2024-10/queries/storeCreditAccount.txt --- # store​Credit​Account query Returns a store credit account resource by ID. ## Arguments * id [ID!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/ID) required The ID of the store credit account to return. *** ## Possible returns * Store​Credit​Account [Store​Credit​Account](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/StoreCreditAccount) 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](https://shopify.dev/docs/api/customer). *** ## Examples * ### Get a store credit account by account ID #### Query ```graphql query storeCreditAccount($accountId: ID!) { storeCreditAccount(id: $accountId) { id balance { amount currencyCode } } } ``` #### Variables ```json { "accountId": "gid://shopify/StoreCreditAccount/316863792" } ``` #### cURL ```bash curl -X POST \ https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \ -H 'Content-Type: application/json' \ -H 'X-Shopify-Access-Token: {access_token}' \ -d '{ "query": "query storeCreditAccount($accountId: ID!) { storeCreditAccount(id: $accountId) { id balance { amount currencyCode } } }", "variables": { "accountId": "gid://shopify/StoreCreditAccount/316863792" } }' ``` #### Remix ```javascript const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql query storeCreditAccount($accountId: ID!) { storeCreditAccount(id: $accountId) { id balance { amount currencyCode } } }`, { variables: { "accountId": "gid://shopify/StoreCreditAccount/316863792" }, }, ); const data = await response.json(); ``` #### Ruby ```ruby session = ShopifyAPI::Auth::Session.new( shop: "your-development-store.myshopify.com", access_token: access_token ) client = ShopifyAPI::Clients::Graphql::Admin.new( session: session ) query = <<~QUERY query storeCreditAccount($accountId: ID!) { storeCreditAccount(id: $accountId) { id balance { amount currencyCode } } } QUERY variables = { "accountId": "gid://shopify/StoreCreditAccount/316863792" } response = client.query(query: query, variables: variables) ``` #### Node.js ```javascript const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `query storeCreditAccount($accountId: ID!) { storeCreditAccount(id: $accountId) { id balance { amount currencyCode } } }`, "variables": { "accountId": "gid://shopify/StoreCreditAccount/316863792" }, }, }); ``` #### Response ```json { "storeCreditAccount": { "id": "gid://shopify/StoreCreditAccount/316863792", "balance": { "amount": "11.11", "currencyCode": "USD" } } } ``` * ### Get the first two expirable credit transactions of a store credit account #### Query ```graphql query storeCreditAccount($accountId: ID!, $first: Int!) { storeCreditAccount(id: $accountId) { id transactions(first: $first, query: "type:credit AND expires_at:*") { edges { node { amount { amount currencyCode } balanceAfterTransaction { amount currencyCode } createdAt ... on StoreCreditAccountCreditTransaction { id expiresAt remainingAmount { amount currencyCode } } } } } } } ``` #### Variables ```json { "accountId": "gid://shopify/StoreCreditAccount/669614221", "first": 2 } ``` #### cURL ```bash curl -X POST \ https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \ -H 'Content-Type: application/json' \ -H 'X-Shopify-Access-Token: {access_token}' \ -d '{ "query": "query storeCreditAccount($accountId: ID!, $first: Int!) { storeCreditAccount(id: $accountId) { id transactions(first: $first, query: \"type:credit AND expires_at:*\") { edges { node { amount { amount currencyCode } balanceAfterTransaction { amount currencyCode } createdAt ... on StoreCreditAccountCreditTransaction { id expiresAt remainingAmount { amount currencyCode } } } } } } }", "variables": { "accountId": "gid://shopify/StoreCreditAccount/669614221", "first": 2 } }' ``` #### Remix ```javascript const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql query storeCreditAccount($accountId: ID!, $first: Int!) { storeCreditAccount(id: $accountId) { id transactions(first: $first, query: "type:credit AND expires_at:*") { edges { node { amount { amount currencyCode } balanceAfterTransaction { amount currencyCode } createdAt ... on StoreCreditAccountCreditTransaction { id expiresAt remainingAmount { amount currencyCode } } } } } } }`, { variables: { "accountId": "gid://shopify/StoreCreditAccount/669614221", "first": 2 }, }, ); const data = await response.json(); ``` #### Ruby ```ruby session = ShopifyAPI::Auth::Session.new( shop: "your-development-store.myshopify.com", access_token: access_token ) client = ShopifyAPI::Clients::Graphql::Admin.new( session: session ) query = <<~QUERY query storeCreditAccount($accountId: ID!, $first: Int!) { storeCreditAccount(id: $accountId) { id transactions(first: $first, query: "type:credit AND expires_at:*") { edges { node { amount { amount currencyCode } balanceAfterTransaction { amount currencyCode } createdAt ... on StoreCreditAccountCreditTransaction { id expiresAt remainingAmount { amount currencyCode } } } } } } } QUERY variables = { "accountId": "gid://shopify/StoreCreditAccount/669614221", "first": 2 } response = client.query(query: query, variables: variables) ``` #### Node.js ```javascript const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `query storeCreditAccount($accountId: ID!, $first: Int!) { storeCreditAccount(id: $accountId) { id transactions(first: $first, query: "type:credit AND expires_at:*") { edges { node { amount { amount currencyCode } balanceAfterTransaction { amount currencyCode } createdAt ... on StoreCreditAccountCreditTransaction { id expiresAt remainingAmount { amount currencyCode } } } } } } }`, "variables": { "accountId": "gid://shopify/StoreCreditAccount/669614221", "first": 2 }, }, }); ``` #### Response ```json { "storeCreditAccount": { "id": "gid://shopify/StoreCreditAccount/669614221", "transactions": { "edges": [ { "node": { "amount": { "amount": "100.0", "currencyCode": "USD" }, "balanceAfterTransaction": { "amount": "100.0", "currencyCode": "USD" }, "createdAt": "2024-01-01T00:00:00Z", "id": "gid://shopify/StoreCreditAccountCreditTransaction/870993577", "expiresAt": "2024-02-01T00:00:00Z", "remainingAmount": { "amount": "50.0", "currencyCode": "USD" } } }, { "node": { "amount": { "amount": "54.99", "currencyCode": "USD" }, "balanceAfterTransaction": { "amount": "104.99", "currencyCode": "USD" }, "createdAt": "2024-01-03T00:00:00Z", "id": "gid://shopify/StoreCreditAccountCreditTransaction/870993579", "expiresAt": "2024-02-03T00:00:00Z", "remainingAmount": { "amount": "54.99", "currencyCode": "USD" } } } ] } } } ``` * ### Get the four most recent transactions of a store credit account #### Query ```graphql query storeCreditAccount($accountId: ID!, $first: Int!) { storeCreditAccount(id: $accountId) { id transactions(first: $first, sortKey: CREATED_AT, reverse: true) { edges { node { amount { amount currencyCode } balanceAfterTransaction { amount currencyCode } createdAt ... on StoreCreditAccountCreditTransaction { id expiresAt remainingAmount { amount currencyCode } } ... on StoreCreditAccountDebitTransaction { id } ... on StoreCreditAccountDebitRevertTransaction { id debitTransaction { id } } ... on StoreCreditAccountExpirationTransaction { creditTransaction { id } } } } } } } ``` #### Variables ```json { "accountId": "gid://shopify/StoreCreditAccount/669614221", "first": 4 } ``` #### cURL ```bash curl -X POST \ https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \ -H 'Content-Type: application/json' \ -H 'X-Shopify-Access-Token: {access_token}' \ -d '{ "query": "query storeCreditAccount($accountId: ID!, $first: Int!) { storeCreditAccount(id: $accountId) { id transactions(first: $first, sortKey: CREATED_AT, reverse: true) { edges { node { amount { amount currencyCode } balanceAfterTransaction { amount currencyCode } createdAt ... on StoreCreditAccountCreditTransaction { id expiresAt remainingAmount { amount currencyCode } } ... on StoreCreditAccountDebitTransaction { id } ... on StoreCreditAccountDebitRevertTransaction { id debitTransaction { id } } ... on StoreCreditAccountExpirationTransaction { creditTransaction { id } } } } } } }", "variables": { "accountId": "gid://shopify/StoreCreditAccount/669614221", "first": 4 } }' ``` #### Remix ```javascript const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql query storeCreditAccount($accountId: ID!, $first: Int!) { storeCreditAccount(id: $accountId) { id transactions(first: $first, sortKey: CREATED_AT, reverse: true) { edges { node { amount { amount currencyCode } balanceAfterTransaction { amount currencyCode } createdAt ... on StoreCreditAccountCreditTransaction { id expiresAt remainingAmount { amount currencyCode } } ... on StoreCreditAccountDebitTransaction { id } ... on StoreCreditAccountDebitRevertTransaction { id debitTransaction { id } } ... on StoreCreditAccountExpirationTransaction { creditTransaction { id } } } } } } }`, { variables: { "accountId": "gid://shopify/StoreCreditAccount/669614221", "first": 4 }, }, ); const data = await response.json(); ``` #### Ruby ```ruby session = ShopifyAPI::Auth::Session.new( shop: "your-development-store.myshopify.com", access_token: access_token ) client = ShopifyAPI::Clients::Graphql::Admin.new( session: session ) query = <<~QUERY query storeCreditAccount($accountId: ID!, $first: Int!) { storeCreditAccount(id: $accountId) { id transactions(first: $first, sortKey: CREATED_AT, reverse: true) { edges { node { amount { amount currencyCode } balanceAfterTransaction { amount currencyCode } createdAt ... on StoreCreditAccountCreditTransaction { id expiresAt remainingAmount { amount currencyCode } } ... on StoreCreditAccountDebitTransaction { id } ... on StoreCreditAccountDebitRevertTransaction { id debitTransaction { id } } ... on StoreCreditAccountExpirationTransaction { creditTransaction { id } } } } } } } QUERY variables = { "accountId": "gid://shopify/StoreCreditAccount/669614221", "first": 4 } response = client.query(query: query, variables: variables) ``` #### Node.js ```javascript const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `query storeCreditAccount($accountId: ID!, $first: Int!) { storeCreditAccount(id: $accountId) { id transactions(first: $first, sortKey: CREATED_AT, reverse: true) { edges { node { amount { amount currencyCode } balanceAfterTransaction { amount currencyCode } createdAt ... on StoreCreditAccountCreditTransaction { id expiresAt remainingAmount { amount currencyCode } } ... on StoreCreditAccountDebitTransaction { id } ... on StoreCreditAccountDebitRevertTransaction { id debitTransaction { id } } ... on StoreCreditAccountExpirationTransaction { creditTransaction { id } } } } } } }`, "variables": { "accountId": "gid://shopify/StoreCreditAccount/669614221", "first": 4 }, }, }); ``` #### Response ```json { "storeCreditAccount": { "id": "gid://shopify/StoreCreditAccount/669614221", "transactions": { "edges": [ { "node": { "amount": { "amount": "-90.0", "currencyCode": "USD" }, "balanceAfterTransaction": { "amount": "0.0", "currencyCode": "USD" }, "createdAt": "2024-02-01T00:00:00Z", "creditTransaction": { "id": "gid://shopify/StoreCreditAccountCreditTransaction/870993581" } } }, { "node": { "amount": { "amount": "40.0", "currencyCode": "USD" }, "balanceAfterTransaction": { "amount": "90.0", "currencyCode": "USD" }, "createdAt": "2024-01-03T00:00:00Z", "id": "gid://shopify/StoreCreditAccountDebitRevertTransaction/870993583", "debitTransaction": { "id": "gid://shopify/StoreCreditAccountDebitTransaction/870993582" } } }, { "node": { "amount": { "amount": "-50.0", "currencyCode": "USD" }, "balanceAfterTransaction": { "amount": "50.0", "currencyCode": "USD" }, "createdAt": "2024-01-02T00:00:00Z", "id": "gid://shopify/StoreCreditAccountDebitTransaction/870993582" } }, { "node": { "amount": { "amount": "100.0", "currencyCode": "USD" }, "balanceAfterTransaction": { "amount": "100.0", "currencyCode": "USD" }, "createdAt": "2024-01-01T00:00:00Z", "id": "gid://shopify/StoreCreditAccountCreditTransaction/870993581", "expiresAt": "2024-02-01T00:00:00Z", "remainingAmount": { "amount": "90.0", "currencyCode": "USD" } } } ] } } } ``` [Open in GraphiQL](http://localhost:3457/graphiql?query=query%20storeCreditAccount\(%24accountId%3A%20ID!\)%20%7B%0A%20%20storeCreditAccount\(id%3A%20%24accountId\)%20%7B%0A%20%20%20%20id%0A%20%20%20%20balance%20%7B%0A%20%20%20%20%20%20amount%0A%20%20%20%20%20%20currencyCode%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D\&variables=%7B%0A%20%20%22accountId%22%3A%20%22gid%3A%2F%2Fshopify%2FStoreCreditAccount%2F316863792%22%0A%7D) ```javascript const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql query storeCreditAccount($accountId: ID!) { storeCreditAccount(id: $accountId) { id balance { amount currencyCode } } }`, { variables: { "accountId": "gid://shopify/StoreCreditAccount/316863792" }, }, ); const data = await response.json(); ``` ## Input variables JSON ```json { "accountId": "gid://shopify/StoreCreditAccount/316863792" } ``` ## Response JSON ```json { "storeCreditAccount": { "id": "gid://shopify/StoreCreditAccount/316863792", "balance": { "amount": "11.11", "currencyCode": "USD" } } } ```