Ramp: 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 recurring settings Complete recurring reminder configuration
Create a vendor agreement: request body, field 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 / recurring_settings / Complete recurring reminder configuration. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: 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 recurring settings Complete recurring reminder configuration
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Complete recurring reminder configuration. “recurring_enabled“ is the on/off switch; the five “recurring_*“ fields describe the configuration. A configured but disabled object is paused (the configuration is retained), while all-null configuration is only valid when disabled. Additional keys: not allowed |
recurring_cadence | JSON | Required within parent | |
recurring_cadence (anyOf 1) | string | Alternative | Repeat frequency, required when recurrence is enabled. BIWEEKLY means every two weeks. One of: BIWEEKLY, DAILY, MONTHLY, WEEKLY, YEARLY |
recurring_cadence (anyOf 2) | null | Alternative | |
recurring_enabled | boolean | Required within parent | On/off switch. False with a configured recurrence pauses it; must be false when recurring_start_type is null. |
recurring_max_occurrences | JSON | Required within parent | |
recurring_max_occurrences (anyOf 1) | integer | Alternative | Optional cap on the number of reminders in the series (occurrences 0..N-1 from the anchor). Null means unlimited. Greater than: 0 |
recurring_max_occurrences (anyOf 2) | null | Alternative | |
recurring_start_event | JSON | Required within parent | |
recurring_start_event (anyOf 1) | string | Alternative | Contract event anchoring recurrence; required when configured. CONTRACT_START_DATE is only valid on perpetual contracts. One of: CONTRACT_ENDS_OR_RENEWS, CONTRACT_START_DATE, LAST_DATE_TO_TERMINATE |
recurring_start_event (anyOf 2) | null | Alternative | |
recurring_start_offset_days | JSON | Required within parent | |
recurring_start_offset_days (anyOf 1) | integer | Alternative | Days relative to the contract event: negative before, zero on, positive after. Required when configured; must be 0 for CONTRACT_START_DATE. |
recurring_start_offset_days (anyOf 2) | null | Alternative | |
recurring_start_type | JSON | Required within parent | |
recurring_start_type (anyOf 1) | string | Alternative | Anchor for recurring reminders; CONTRACT_EVENT is the only value. When null, all companion fields must also be null. One of: CONTRACT_EVENT |
recurring_start_type (anyOf 2) | null | Alternative |