---
title: "Retrieve a sub-entity's payout schedule"
method: GET
path: "/accounts/entities/{id}/payout-schedules"
tags: ["Payout schedules"]
---

# Retrieve a sub-entity's payout schedule

`GET /accounts/entities/{id}/payout-schedules`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{id}/payout-schedules`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `string` scopes: `accounts`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/accounts/entities/:id/payout-schedules/get.ts> (a function with typed inputs; its response is checked against the schema)

You can schedule when your sub-entities receive their funds using our <a href="https://checkout.com/docs/platforms" target="_blank">Platforms solution</a>. Use this endpoint to retrieve information about a sub-entity's schedule.

## Path parameters

- `id` string, required

## Response `200`

Schedule retrieved successfully

- union
  - object
    - `GBP` object: The three-letter ISO currency code of the account's currency.
      - `recurrence` object: Information about how often the schedule takes place.
        - `enabled` boolean: Indicates the status of the payout schedule.
        - `threshold` number: Minimum available balance on the account to do a payout. If the balance is less than the threshold, then the payout instruction will not send.
        - `payment_instrument_id` string: The ID of the platforms payment instrument used for payouts on this schedule.
        - `schedule` object: Details about the payout schedule. Required if `enabled` is set to `true`.
          - `frequency` 'weekly' | 'daily' | 'monthly', required: Used to indicate how often funds should be paid out to a sub-entity.
      - `_links` unknown
  - object
    - `GBP` object: The three-letter ISO currency code of the account's currency.
      - `recurrence` object: Information about how often the payout takes place.
        - `enabled` boolean: Indicates whether the payout schedule is enabled.
        - `threshold` number: The minimum balance, in the minor units of the schedule's currency, required for a payout to take place. If the sub-entity's available balance is below the `threshold`, Checkout.com does not send the payout instruction. Defaults to `0` if you do not set it.
        - `balance_minimum` number, nullable: The amount, in the minor units of the schedule's currency, to retain in the sub-entity's available balance. Checkout.com pays out only the funds above the `balance_minimum`, and generates no payout if there are none. Defaults to `0` if you do not set it.
        - `carry_forward_enabled` boolean, nullable: Indicates whether to carry forward any balance below the configured minimum to the next payout. Always returned for SaaS sellers, and defaults to `false` if you do not set it.
        - `payment_instrument_id` string: The ID of the platforms payment instrument used for payouts on this schedule.
        - `schedule` object: Details about the payout schedule. Required if `enabled` is set to `true`.
          - `frequency` 'weekly' | 'daily' | 'monthly', required: Used to indicate how often funds should be paid out to a sub-entity.
      - `_links` unknown

## Other responses

- `401`: Unauthorized.
- `404`: Sub-entity not found, or scheduled payouts are not available to the sub-entity.
- `422`: Invalid data sent.
- `429`: Too many requests.

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)