Ramp: Suspend a fund member
Ramp fund.postFundMemberSuspension: arguments, response, policy and SDK examples.
← Fund operations · Get started
Operation ramp.post_fund_member_suspension
Provider route: POST /developer/v1/funds/{fund_id}/members/{user_id}/suspension. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["fund"]["postFundMemberSuspension"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.fund.postFundMemberSuspension(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_ramp import RampIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.fund.post_fund_member_suspension(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.fund_id | string | Required within parent | |
path.user_id | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Fetch a fund — response body |
Referenced models: Fetch a fund — response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
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
Fetch a fund — response body — cards item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
card_id | string | Required within parent | Unique identifier of the card. Format: uuid |
created_at | string | Required within parent | Time the card was created. Format: date-time |
display_name | string | Required within parent | Display name of the card. |
expiration | string | Required within parent | Expiration date in MMYY format. Redacted if the card has not been activated. Read only: true |
last_four | string | Required within parent | Last four digits of the card number. Redacted if the card has not been activated. Read only: true |
user_id | string | Required within parent | Unique identifier of the cardholder. Format: uuid |
Fetch a fund — response body — members item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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 for this member, or null if not suspended. Read only: true |
suspension (anyOf 2) | null | Alternative | |
user_id | string | Required within parent | Unique identifier of the fund member. Format: uuid |
Referenced models: Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id
Fetch a fund — response body — permitted spend types
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
physical_card_enabled | boolean | Required within parent | Whether the user's physical card can be linked to this fund. |
reimbursements_enabled | boolean | Required within parent | Whether reimbursements can be submitted against this fund. |
virtual_card_enabled | boolean | Required within parent | Whether virtual cards can be linked to this fund. |
Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
suspended_at | JSON | Required within parent | |
suspended_at (anyOf 1) | string | Alternative | Date and time at which the suspension was placed. Format: date-time |
suspended_at (anyOf 2) | null | Alternative | |
suspended_by_ramp | boolean | Required within parent | Whether the suspension was placed by Ramp. Read only: true |
suspended_by_user_id | JSON | Required within parent | |
suspended_by_user_id (anyOf 1) | string | Alternative | Unique identifier of the user who placed the suspension. Format: uuid Read only: true |
suspended_by_user_id (anyOf 2) | null | Alternative |
Fetch a fund — response body — balance cleared, pending, total
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cleared | Model | Required within parent | Expand Hold Bill — response body — amount Cleared amount on this fund. Read only: true |
pending | Model | Required within parent | Expand Hold Bill — response body — amount Pending amount towards this fund. Read only: true |
total | Model | Required within parent | Expand Hold Bill — response body — amount Total amount spent on this fund. Read only: true |
Referenced models: Hold Bill — response body — amount
Hold Bill — response body — amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | the amount of money represented in the smallest denomination of the currency. For example, when the currency is USD, then the amount is expressed in cents. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency_code | string | Required within parent | The type of currency, in ISO 4217 format. e.g. USD for US dollars Default: USD |
minor_unit_conversion_rate | JSON | Required within parent | |
minor_unit_conversion_rate (anyOf 1) | JSON | Alternative | |
minor_unit_conversion_rate (anyOf 1) (anyOf 1) | integer | Alternative | The conversion factor to convert from the integer amount to the actual currency value. Divide amount by this value to get the real currency amount. For USD, this is 100 (e.g., 12034 / 100 = 120.34 USD). See https://docs.ramp.com/developer-api/v1/monetary-values for more information. Read only: true |
minor_unit_conversion_rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minor_unit_conversion_rate (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.post_fund_member_suspension. Catalog operation: post_fund_member_suspension. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["funds:write"]