Ramp: Create a vendor agreement — request body — body
Create a vendor agreement: request body, field body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Create a vendor agreement — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
auto_renewal | boolean | Required within parent | Whether the agreement automatically renews. |
contract_owner_ids | JSON | Optional | |
contract_owner_ids (anyOf 1) | array | Alternative | List of contract owner user IDs. |
contract_owner_ids (anyOf 1)[] | string | Each item | Format: uuid |
contract_owner_ids (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the vendor agreement. Default: null |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | End date of the agreement. Default: null Format: date |
end_date (anyOf 2) | null | Alternative | |
last_date_to_terminate | JSON | Optional | |
last_date_to_terminate (anyOf 1) | string | Alternative | Last date by which the agreement can be terminated. Default: null Format: date |
last_date_to_terminate (anyOf 2) | null | Alternative | |
line_items | JSON | Optional | |
line_items (anyOf 1) | array | Alternative | Line items associated with the agreement. Default: null |
line_items (anyOf 1)[] | Model | Each item | Expand Create a vendor agreement — request body — body line items Line items associated with the agreement item |
line_items (anyOf 2) | null | Alternative | |
name | string | Required within parent | Name of the vendor agreement. Minimum length: 1 |
notifications_on | boolean | Required within parent | Whether notifications are enabled for this agreement. |
renewal_notification_settings | JSON | Optional | |
renewal_notification_settings (anyOf 1) | Model | Alternative | Expand Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers Notification settings to apply to this agreement. Default: null |
renewal_notification_settings (anyOf 2) | null | Alternative | |
start_date | string | Required within parent | Start date of the agreement. Format: date |
total_value | Model | Required within parent | Expand Create a vendor agreement — request body — body total value Total monetary value of the agreement. |
Referenced models: Create a vendor agreement — request body — body total value, Create a vendor agreement — request body — body line items Line items associated with the agreement item, Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers