API version: unstable
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

Balance

Version 2020-01
The account's current balance. This amount is comprised of any Transaction not yet included in a Payout.

What you can do with Balance

The Shopify API lets you do the following with the Balance resource. More detailed versions of these general actions may be available:

Endpoints

GET /admin/api/2020-01/shopify_payments/balance.json
Retrieves the account's current balance.

Retrieves the account's current balance.

GET /admin/api/2020-01/shopify_payments/balance.json
View Response
HTTP/1.1 200 OK
{
  "balance": [
    {
      "currency": "USD",
      "amount": "53.99"
    }
  ]
}
Version 2020-04
The account's current balance. This amount is comprised of any Transaction not yet included in a Payout.

What you can do with Balance

The Shopify API lets you do the following with the Balance resource. More detailed versions of these general actions may be available:

Endpoints

GET /admin/api/2020-04/shopify_payments/balance.json
Retrieves the account's current balance.

Retrieves the account's current balance.

GET /admin/api/2020-04/shopify_payments/balance.json
View Response
HTTP/1.1 200 OK
{
  "balance": [
    {
      "currency": "USD",
      "amount": "53.99"
    }
  ]
}
Version 2020-07
The account's current balance. This amount is comprised of any Transaction not yet included in a Payout.

What you can do with Balance

The Shopify API lets you do the following with the Balance resource. More detailed versions of these general actions may be available:

Endpoints

GET /admin/api/2020-07/shopify_payments/balance.json
Retrieves the account's current balance.

Retrieves the account's current balance.

GET /admin/api/2020-07/shopify_payments/balance.json
View Response
HTTP/1.1 200 OK
{
  "balance": [
    {
      "currency": "USD",
      "amount": "53.99"
    }
  ]
}
Version 2020-10 (Latest)
The account's current balance. This amount is comprised of any Transaction not yet included in a Payout.

What you can do with Balance

The Shopify API lets you do the following with the Balance resource. More detailed versions of these general actions may be available:

Endpoints

GET /admin/api/2020-10/shopify_payments/balance.json
Retrieves the account's current balance.

Retrieves the account's current balance.

GET /admin/api/2020-10/shopify_payments/balance.json
View Response
HTTP/1.1 200 OK
{
  "balance": [
    {
      "currency": "USD",
      "amount": "53.99"
    }
  ]
}
Version 2021-01 (Release candidate)
The account's current balance. This amount is comprised of any Transaction not yet included in a Payout.

What you can do with Balance

The Shopify API lets you do the following with the Balance resource. More detailed versions of these general actions may be available:

Endpoints

GET /admin/api/2021-01/shopify_payments/balance.json
Retrieves the account's current balance.

Retrieves the account's current balance.

GET /admin/api/2021-01/shopify_payments/balance.json
View Response
HTTP/1.1 200 OK
{
  "balance": [
    {
      "currency": "USD",
      "amount": "53.99"
    }
  ]
}
Version unstable
The account's current balance. This amount is comprised of any Transaction not yet included in a Payout.

What you can do with Balance

The Shopify API lets you do the following with the Balance resource. More detailed versions of these general actions may be available:

Endpoints

GET /admin/api/unstable/shopify_payments/balance.json
Retrieves the account's current balance.

Retrieves the account's current balance.

GET /admin/api/unstable/shopify_payments/balance.json
View Response
HTTP/1.1 200 OK
{
  "balance": [
    {
      "currency": "USD",
      "amount": "53.99"
    }
  ]
}