ROOKDocs
Sign In
POST

Create an interest-tier schedule

ENDPOINT/v1/interest-tier-schedules

Creates a dated set of balance-banded APRs on a credit product. Send contiguous tiers with min_balance, max_balance, and apr as a decimal string of basis points. A range that overlaps another schedule on the same product returns 409. Send Idempotency-Key so retries return the original schedule instead of creating a second one.

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.
Content-TypestringREQUIREDMust be application/json.
Idempotency-KeystringOPTIONALUnique UUID to prevent duplicate execution of financial creations or mutations.

Request Body Schema

application/json
credit_product_idstringuuid
REQUIRED

Credit product this schedule belongs to. Same value as the Product `id`.

namestring
REQUIRED

Display name of this schedule.

effective_fromstringdate
REQUIRED

First calendar day this schedule is in force, in the program timezone.

effective_tostringnulldate
optional

Last calendar day this schedule is in force, inclusive. Null or omitted for an open-ended range.

tiersarray
REQUIRED

Ordered balance bands. The first `min_balance.amount` is `0`. Each subsequent `min_balance` equals the previous `max_balance`. The last tier's `max_balance` is null.

Properties of tiers
min_balanceobjectrequired
A monetary value stored as an integer number of minor units plus an ISO 4217 currency code. Never a float, never a decimal string. For `USD`, `amount` is cents (`1250` is $12.50).
max_balanceanyrequired
Exclusive upper bound of this tier. Null on the last tier (no upper bound). `amount` is a non-negative integer of minor units; `100000` with `USD` is $1,000.00.
aprstringrequired
A rate in basis points encoded as a decimal string. One basis point is 0.01 percent. Precision is at most four digits after the decimal point; values with fewer fractional digits are stored at four-decimal precision. `"2499.0000"` is 24.99% APR. `"12.5"` is 12.5 basis points (0.125%). Never a JSON number and never a float. Do not send more than four fractional digits, a leading sign, scientific notation, or a percent sign.

Response Codes & Schemas

201The interest-tier schedule was created.
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"
  }
}
409Conflict: incompatible state, or Idempotency-Key reused with a different body.
application/json
{
  "error": {
    "type": "conflict_error",
    "code": "conflict",
    "message": "The card cannot be reissued from its current state.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/conflict"
  }
}
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"
  }
}