Ramp: Fetch a fund — response body
Fetch a fund: response body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Fetch a fund — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
balance | JSON | Required within parent | |
balance (anyOf 1) | Model | Alternative | Expand Fetch a fund — response body — balance cleared, pending, total Current balance of the fund. Read only: true |
balance (anyOf 2) | null | Alternative | |
cards | array | Required within parent | Cards linked to this fund. |
cards[] | Model | Each item | Expand Fetch a fund — response body — cards item |
created_at | string | Required within parent | Time at which the fund was created, in ISO 8601 format. Format: date-time |
display_name | string | Required within parent | Display name of the fund. |
entity_id | JSON | Required within parent | |
entity_id (anyOf 1) | string | Alternative | Associated business entity of the fund. Format: uuid |
entity_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier of the fund. Format: uuid |
is_exempt_from_policy_agent | boolean | Required within parent | Whether this fund is exempt from policy agent review. |
is_shareable | boolean | Required within parent | Whether this fund is shareable among multiple users. |
members | array | Required within parent | Members who can spend from the fund. |
members[] | Model | Each item | Expand Fetch a fund — response body — members item |
overrides_spend_program | boolean | Required within parent | Whether the fund’s settings override those of its spend program. |
permitted_spend_types | Model | Required within parent | Expand Fetch a fund — response body — permitted spend types Permitted spend types for this fund. |
spend_program_id | JSON | Required within parent | |
spend_program_id (anyOf 1) | string | Alternative | Unique identifier of the associated spend program. Format: uuid |
spend_program_id (anyOf 2) | null | Alternative | |
spending_restrictions | JSON | Required within parent | |
spending_restrictions (anyOf 1) | Model | Alternative | Expand Fetch a fund — response body — spending_restrictions / interval: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY Spending restrictions on this fund. Read only: true |
spending_restrictions (anyOf 2) | null | Alternative | |
state | string | Required within parent | Current state of the fund: ACTIVE, SUSPENDED, or TERMINATED. Known values: ACTIVE, ARCHIVED, SUSPENDED, TERMINATED Read only: true |
suspension | JSON | Required within parent | |
suspension (anyOf 1) | Model | Alternative | Expand Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id Suspension details at the fund level, or null if the fund is not suspended. Read only: true |
suspension (anyOf 2) | null | Alternative |
Referenced models: Fetch a fund — response body — cards item, Fetch a fund — response body — members item, Fetch a fund — response body — permitted spend types, Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id, Fetch a fund — response body — balance cleared, pending, total, Fetch a fund — response body — spending_restrictions / interval: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY