PUT////
Update a specific APR policy.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the APR policy to update. Send a GET request to /policies/aprs to retrieve existing APR policy tokens.Allowable Values: Existing APR policy token |
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the APR policy. Allowable Values: 36 char max |
| name string Required | Name of the APR policy. Allowable Values: 255 char max |
| description string Optional | Description of the APR policy. Allowable Values: 255 char max |
| purchases object Optional | Contains information on the pricing strategy for purchases. Allowable Values: Existing purchases object |
| purchases.name string Optional | Name of the pricing strategy. Allowable Values: 255 char max |
| purchases.external_token string Optional | Unique identifier of the external pricing strategy for the credit program. Allowable Values: Valid external pricing strategy token |
| purchases.tiers array of objects Required | One or more risk tiers for a pricing strategy. Allowable Values: One or more tiers objects |
| purchases.tiers[].margin_rate decimal Required | Number of percentage points added to the prime rate, used to calculate a variable APR value. Allowable Values: Format: 0.00 |
Sample request body
JSON
{
"token": "my_apr_policy_token_1234",
"name": "Renamed APR Policy",
"description": "Description of the renamed 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
}
]
}
}
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the APR policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the APR policy. Allowable Values: 255 char max |
| description string Conditionally returned | Description of the APR policy. Allowable Values: 255 char max |
| purchases object Conditionally returned | Contains information on the pricing strategy for purchases. Allowable Values: Existing purchases object |
| purchases.name string Conditionally returned | Name of the pricing strategy. Allowable Values: 255 char max |
| purchases.external_token string Conditionally returned | Unique identifier of the pricing strategy on a credit program. Allowable Values: 36 char max |
| purchases.tiers array of objects Conditionally returned | One or more risk tiers for a pricing strategy. Allowable Values: One or more tiers objects |
| purchases.tiers[].margin_rate decimal Conditionally returned | Margin rate for the risk tier for a pricing strategy. Allowable Values: Format: 0.00 |
| purchases.tiers[].apr decimal Conditionally returned | Value of the APR. Allowable Values: Format: 0.00 |
| effective_date date Conditionally returned | Date the APR goes into effect, in UTC. Allowable Values: Format: yyyy-MM-dd |
| 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 |
| 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 |