Anchor to section titled 'undefined'

storeCreditAccountDebit
mutation

Requires write_store_credit_account_transactions access scope.

Creates a debit transaction that decreases the store credit account balance by the given amount.


The input fields for a store credit account debit transaction.

Anchor to id
id
required

The ID of the store credit account or the ID of the account owner.


Was this section helpful?

The store credit account transaction that was created.

The list of errors that occurred from executing the mutation.


Was this section helpful?

Examples

Hide code
Copy
mutation storeCreditAccountDebit($id: ID!, $debitInput: StoreCreditAccountDebitInput!) {
  storeCreditAccountDebit(id: $id, debitInput: $debitInput) {
    storeCreditAccountTransaction {
      amount {
        amount
        currencyCode
      }
      account {
        id
        balance {
          amount
          currencyCode
        }
      }
    }
    userErrors {
      message
      field
    }
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation storeCreditAccountDebit($id: ID!, $debitInput: StoreCreditAccountDebitInput!) { storeCreditAccountDebit(id: $id, debitInput: $debitInput) { storeCreditAccountTransaction { amount { amount currencyCode } account { id balance { amount currencyCode } } } userErrors { message field } } }",
 "variables": {
    "id": "gid://shopify/StoreCreditAccount/316863792",
    "debitInput": {
      "debitAmount": {
        "amount": "9.99",
        "currencyCode": "USD"
      }
    }
  }
}'
const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation storeCreditAccountDebit($id: ID!, $debitInput: StoreCreditAccountDebitInput!) {
    storeCreditAccountDebit(id: $id, debitInput: $debitInput) {
      storeCreditAccountTransaction {
        amount {
          amount
          currencyCode
        }
        account {
          id
          balance {
            amount
            currencyCode
          }
        }
      }
      userErrors {
        message
        field
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/StoreCreditAccount/316863792",
      "debitInput": {
        "debitAmount": {
          "amount": "9.99",
          "currencyCode": "USD"
        }
      }
    },
  },
);

const data = await response.json();
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
  mutation storeCreditAccountDebit($id: ID!, $debitInput: StoreCreditAccountDebitInput!) {
    storeCreditAccountDebit(id: $id, debitInput: $debitInput) {
      storeCreditAccountTransaction {
        amount {
          amount
          currencyCode
        }
        account {
          id
          balance {
            amount
            currencyCode
          }
        }
      }
      userErrors {
        message
        field
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/StoreCreditAccount/316863792",
  "debitInput": {
    "debitAmount": {
      "amount": "9.99",
      "currencyCode": "USD"
    }
  }
}

response = client.query(query: query, variables: variables)
const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation storeCreditAccountDebit($id: ID!, $debitInput: StoreCreditAccountDebitInput!) {
      storeCreditAccountDebit(id: $id, debitInput: $debitInput) {
        storeCreditAccountTransaction {
          amount {
            amount
            currencyCode
          }
          account {
            id
            balance {
              amount
              currencyCode
            }
          }
        }
        userErrors {
          message
          field
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/StoreCreditAccount/316863792",
      "debitInput": {
        "debitAmount": {
          "amount": "9.99",
          "currencyCode": "USD"
        }
      }
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<QUERY
  mutation storeCreditAccountDebit($id: ID!, $debitInput: StoreCreditAccountDebitInput!) {
    storeCreditAccountDebit(id: $id, debitInput: $debitInput) {
      storeCreditAccountTransaction {
        amount {
          amount
          currencyCode
        }
        account {
          id
          balance {
            amount
            currencyCode
          }
        }
      }
      userErrors {
        message
        field
      }
    }
  }
QUERY;

$variables = [
  "id" => "gid://shopify/StoreCreditAccount/316863792",
  "debitInput" => [
    "debitAmount" => [
      "amount" => "9.99",
      "currencyCode" => "USD",
    ],
  ],
];

$response = $client->query(["query" => $query, "variables" => $variables]);
Hide code
Input variables
Copy
{
  "id": "gid://shopify/StoreCreditAccount/316863792",
  "debitInput": {
    "debitAmount": {
      "amount": "9.99",
      "currencyCode": "USD"
    }
  }
}
Hide code
Response
JSON
{
  "storeCreditAccountDebit": {
    "storeCreditAccountTransaction": {
      "amount": {
        "amount": "-9.99",
        "currencyCode": "USD"
      },
      "account": {
        "id": "gid://shopify/StoreCreditAccount/316863792",
        "balance": {
          "amount": "1.12",
          "currencyCode": "USD"
        }
      }
    },
    "userErrors": []
  }
}