Sign in
Cashback Rules

List Cashback Rules

Lists all cashback rules funded by the authenticated platform account. Includes scheduled, expired, and discarded rules. Requires payout:transfer:read. Account-scoped credentials are required; there is no caller-supplied funding-account filter.

get/cashback_rules

Query parameters

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

order'created_at'

Field to sort by. Defaults to created_at.

direction'asc' | 'desc'

Sort direction. Defaults to desc.

Response

cashback rules listed

Example response

{
  "data": [
    {
      "created_at": "2026-01-01T12:00:00.000Z",
      "description": "Cloud cashback",
      "expires_at": "2026-01-01T12:00:00.000Z",
      "funding_account_id": "biz_xxxxxxxxxxxxxx",
      "id": "cicbr_xxxxxxxxxxxxxx",
      "merchant_category_code": "7372",
      "merchant_name": "ACME CLOUD",
      "rate_bps": 500,
      "scoped_account_id": "biz_xxxxxxxxxxxxxx",
      "starts_at": "2026-01-01T12:00:00.000Z",
      "updated_at": "2026-01-01T12:00:00.000Z"
    }
  ]
}

Changes

Changed in 2 of the 74 revisions of this API.32

  • 140d015b99662See the full diff
    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

  • ff3a7657356312See the full diff
    • ▲

      for the query request parameter first, default value 20 was added

      request-parameter-default-value-added

    • ●

      for the query request parameter first, the max was set to 100.00

      request-parameter-max-set

    • ●

      for the query request parameter last, the max was set to 100.00

      request-parameter-max-set

Of the 74 revisions, 1 has no diff computed.