GET/////
Retrieve an array of the historic annual percentage rate (APR) schedules on a specific APR policy.
This endpoint supports sorting and pagination.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the APR policy on which to retrieve APR schedules. Send a GET request to /policies/aprs to retrieve existing product policy tokens.Allowable Values: Existing APR policy token |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of APR schedule resources to retrieve. Allowable Values: 1–100 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: 0 min |
| sort_by string Optional | Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.NOTE: You must sort using system field names such as lastModifiedTime, and not by the field names appearing in response bodies such as last_modified_time.Allowable Values: lastModifiedTime, -lastModifiedTime |
Response body
| Fields | Description |
|---|---|
| count integer Returned | Number of resources returned. Allowable Values: 1-10 |
| start_index integer Returned | Sort order index of the first resource in the returned array. Allowable Values: Any integer |
| end_index integer Returned | Sort order index of the last resource in the returned array. Allowable Values: Any integer |
| is_more boolean Returned | A value of true indicates that more unreturned resources exist.Allowable Values: true, false |
| data array of objects Returned | One or more APR policies. Allowable Values: One or more APR policy objects |
| data[].token string Conditionally returned | Unique identifier of the APR policy. Allowable Values: 36 char max |
| data[].name string Conditionally returned | Name of the APR policy. Allowable Values: 255 char max |
| data[].description string Conditionally returned | Description of the APR policy. Allowable Values: 255 char max |
| data[].purchases object Conditionally returned | Contains information on the pricing strategy for purchases. Allowable Values: Existing purchases object |
| data[].purchases.name string Conditionally returned | Name of the pricing strategy. Allowable Values: 255 char max |
| data[].purchases.external_token string Conditionally returned | Unique identifier of the pricing strategy on a credit program. Allowable Values: 36 char max |
| data[].purchases.tiers array of objects Conditionally returned | One or more risk tiers for a pricing strategy. Allowable Values: One or more tiers objects |
| data[].purchases.tiers[].margin_rate decimal Conditionally returned | Margin rate for the risk tier for a pricing strategy. Allowable Values: Format: 0.00 |
| data[].purchases.tiers[].apr decimal Conditionally returned | Value of the APR. Allowable Values: Format: 0.00 |
| data[].effective_date date Conditionally returned | Date the APR goes into effect, in UTC. Allowable Values: Format: yyyy-MM-dd |
| data[].created_time datetime Conditionally returned | Date and time when the APR policy was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].updated_time datetime Conditionally returned | Date and time when the APR policy was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"count": 2,
"start_index": 0,
"end_index": 2,
"is_more": true,
"data": [
{
"token": "my_apr_policy_token_1234",
"name": "Gold APR Policy",
"description": "A gold APR policy",
"purchases": {
"name": "A purchase at a merchant",
"external_token": "my_external_purchase_token1234",
"tiers": [
{
"margin_rate": 1,
"apr": 0
},
{
"margin_rate": 5,
"apr": 0
}
]
},
"effective_date": "2025-05-01",
"created_time": "2025-04-01T23:41:58.802Z",
"updated_time": "2025-04-05T16:04:48.643Z"
},
{
"token": "my_apr_policy_token_4321",
"name": "Silver APR Policy",
"description": "A silver APR policy",
"purchases": {
"name": "A purchase at a merchant",
"external_token": "my_external_purchase_token4321",
"tiers": [
{
"margin_rate": 1,
"apr": 0
},
{
"margin_rate": 5,
"apr": 0
}
]
},
"effective_date": "2025-06-01",
"created_time": "2025-04-01T23:41:58.802Z",
"updated_time": "2025-04-05T16:04:48.643Z"
}
]
}