ROOKDocs
GET

Retrieve an interest-tier schedule

ENDPOINT/v1/interest-tier-schedules/{interest_tier_schedule_id}

Returns a single interest-tier schedule by id, including its effective date range and the ordered tiers of min/max balance and APR. APR values are decimal strings of basis points. This operation is program-scoped.

Authentication & Headers

HeaderTypeRequirementDescription
AuthorizationstringREQUIREDAPI key passed as an HTTP Bearer token: Bearer rk_live_...
X-Program-IDUUIDPROGRAM-SCOPEDProgram boundary UUID that scopes the issuing card, wallet, or transfer.

Path Parameters

ParameterTypeRequirementDescription
interest_tier_schedule_idstringREQUIREDUnique identifier of the interest-tier schedule.

Response Codes & Schemas

200The requested interest-tier schedule.
application/json
{
  "id": "8c1f5a29-3e6b-4d47-b9a2-7e4d0c8f1358",
  "object": "interest_tier_schedule",
  "credit_product_id": "3f0c7a12-5d8e-4a91-b6c2-9e1f0a4d7c33",
  "name": "Standard revolving",
  "effective_from": "2026-01-01",
  "effective_to": null,
  "tiers": [
    {
      "min_balance": {
        "amount": 0,
        "currency": "USD"
      },
      "max_balance": {
        "amount": 100000,
        "currency": "USD"
      },
      "apr": "1499.0000"
    },
    {
      "min_balance": {
        "amount": 100000,
        "currency": "USD"
      },
      "max_balance": {
        "amount": 500000,
        "currency": "USD"
      },
      "apr": "1899.0000"
    },
    {
      "min_balance": {
        "amount": 500000,
        "currency": "USD"
      },
      "max_balance": null,
      "apr": "2499.0000"
    }
  ],
  "created_at": "2026-01-02T16:20:00Z",
  "updated_at": "2026-01-02T16:20:00Z"
}
400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.
application/json
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "invalid order by: foo. Valid options are: [created_at updated_at]",
    "param": "order_by",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/invalid_request"
  }
}
401Unauthorized: missing, malformed, or unknown API key.
application/json
{
  "error": {
    "type": "authentication_error",
    "code": "authentication_error",
    "message": "A valid API key is required.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/authentication_error"
  }
}
403Forbidden: the API key is denied by RBAC, or it cannot access this program. A resource that exists on another program or organization returns `404 not_found`, not `403`.
application/json
{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The API key cannot access this program.",
    "param": "X-Program-ID",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/permission_denied"
  }
}
404Not Found: unknown id, or the resource is not visible to this API key.
application/json
{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "No card found for the given id.",
    "param": "card_id",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/not_found"
  }
}
429Too Many Requests: the API key exceeded its rate limit.
application/json
{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/rate_limited"
  }
}
500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.
application/json
{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/internal_error"
  }
}