Skip to content

Ramp: Create a vendor agreement

Ramp vendor.postVendorAgreementCreateResource: arguments, response, policy and SDK examples.

← Vendor operations · Get started

Operation ramp.post_vendor_agreement_create_resource

Provider route: POST /developer/v1/vendors/{vendor_id}/agreements. Alter supplies the connection’s credentials and routing.

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["vendor"]["postVendorAgreementCreateResource"]>[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.vendor.postVendorAgreementCreateResource(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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.vendor.post_vendor_agreement_create_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.vendor_idstringRequired within parent
bodyModelRequired within parentExpand Create a vendor agreement — request body — body

Referenced models: Create a vendor agreement — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Fetch a vendor agreement — response body

Referenced models: Fetch a vendor agreement — response body

49 more schemas are linked from the tables above, on the schema pages.

Create a vendor agreement — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
auto_renewalbooleanRequired within parentWhether the agreement automatically renews.
contract_owner_idsJSONOptional
contract_owner_ids (anyOf 1)arrayAlternativeList of contract owner user IDs.
contract_owner_ids (anyOf 1)[]stringEach itemFormat: uuid
contract_owner_ids (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the vendor agreement.
Default: null
description (anyOf 2)nullAlternative
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeEnd date of the agreement.
Default: null
Format: date
end_date (anyOf 2)nullAlternative
last_date_to_terminateJSONOptional
last_date_to_terminate (anyOf 1)stringAlternativeLast date by which the agreement can be terminated.
Default: null
Format: date
last_date_to_terminate (anyOf 2)nullAlternative
line_itemsJSONOptional
line_items (anyOf 1)arrayAlternativeLine items associated with the agreement.
Default: null
line_items (anyOf 1)[]ModelEach itemExpand Create a vendor agreement — request body — body line items Line items associated with the agreement item
line_items (anyOf 2)nullAlternative
namestringRequired within parentName of the vendor agreement.
Minimum length: 1
notifications_onbooleanRequired within parentWhether notifications are enabled for this agreement.
renewal_notification_settingsJSONOptional
renewal_notification_settings (anyOf 1)ModelAlternativeExpand 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)nullAlternative
start_datestringRequired within parentStart date of the agreement.
Format: date
total_valueModelRequired within parentExpand 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

Create a vendor agreement — request body — body total value
FieldTypePresenceDescription and constraints
$objectRoot
amountintegerRequired within parentMonetary amount in the currency's minor unit.
currency_codeModelOptionalExpand Edit a procurement request — request body — body currency
Three-letter ISO currency code for the amount.
Default: USD

Referenced models: Edit a procurement request — request body — body currency

Create a vendor agreement — request body — body line items Line items associated with the agreement item
FieldTypePresenceDescription and constraints
$objectRoot
discountJSONOptional
discount (anyOf 1)JSONAlternativeDiscount applied to the line item, if any.
Default: null
discount (anyOf 1) (oneOf 1)numberAlternative
discount (anyOf 1) (oneOf 2)stringAlternative
discount (anyOf 2)nullAlternative
price_per_unitJSONRequired within parentPrice for a single unit in the line item.
price_per_unit (oneOf 1)numberAlternative
price_per_unit (oneOf 2)stringAlternative
product_or_service_namestringRequired within parentName of the product or service covered by the agreement line item.
quantityJSONRequired within parentQuantity of units included in the line item.
quantity (oneOf 1)numberAlternative
quantity (oneOf 2)stringAlternative
termJSONOptional
term (anyOf 1)stringAlternativeFreeform term label for the line item, if applicable.
Default: null
term (anyOf 2)nullAlternative
time_unitJSONOptional
time_unit (anyOf 1)stringAlternativeTime unit associated with the line item, if applicable.
Default: null
time_unit (anyOf 2)nullAlternative
total_priceJSONOptional
total_price (anyOf 1)JSONAlternativeTotal price for the line item, if provided.
Default: null
total_price (anyOf 1) (oneOf 1)numberAlternative
total_price (anyOf 1) (oneOf 2)stringAlternative
total_price (anyOf 2)nullAlternative
unitJSONOptional
unit (anyOf 1)stringAlternativeUnit name for the quantity, if applicable.
Default: null
unit (anyOf 2)nullAlternative
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
FieldTypePresenceDescription and constraints
$objectRootComplete notification configuration used by create, merge, and the developer API.

Omitted or null fields take their empty/false defaults; omitted or null
``recurring_settings`` disables recurrence. Omitted or null
``scheduled_enabled`` keeps the replaced group's value (true for new groups).
notification_triggersJSONOptional
notification_triggers (anyOf 1)arrayAlternativeDefault: null
notification_triggers (anyOf 1)[]ModelEach itemExpand 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 triggers array item
notification_triggers (anyOf 2)nullAlternative
recipient_approval_group_uuidsJSONOptional
recipient_approval_group_uuids (anyOf 1)arrayAlternativeDefault: null
recipient_approval_group_uuids (anyOf 1)[]stringEach item
recipient_approval_group_uuids (anyOf 2)nullAlternative
recipient_dynamic_user_group_uuidsJSONOptional
recipient_dynamic_user_group_uuids (anyOf 1)arrayAlternativeDefault: null
recipient_dynamic_user_group_uuids (anyOf 1)[]stringEach item
recipient_dynamic_user_group_uuids (anyOf 2)nullAlternative
recipient_user_uuidsJSONOptional
recipient_user_uuids (anyOf 1)arrayAlternativeDefault: null
recipient_user_uuids (anyOf 1)[]stringEach item
recipient_user_uuids (anyOf 2)nullAlternative
recurring_settingsJSONOptional
recurring_settings (anyOf 1)ModelAlternativeExpand 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
Complete recurring configuration; omission or null disables recurrence.
Default: null
recurring_settings (anyOf 2)nullAlternative
scheduled_enabledJSONOptional
scheduled_enabled (anyOf 1)booleanAlternativePauses scheduled reminders when false; null preserves the current value.
Default: null
scheduled_enabled (anyOf 2)nullAlternative
should_notify_contract_owner_managersbooleanOptionalDefault: false

Referenced models: 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 triggers array 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 recurring settings Complete recurring reminder configuration

Fetch a vendor agreement — response body — contract owners item
FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parent
first_namestringRequired within parent
full_namestringRequired within parent
idstringRequired within parentFormat: uuid
last_namestringRequired within parent
profile_picture_urlJSONOptional
profile_picture_url (anyOf 1)stringAlternative
profile_picture_url (anyOf 2)nullAlternative

SDK function policy ID: ramp.post_vendor_agreement_create_resource. Catalog operation: post_vendor_agreement_create_resource. 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: ["vendors:write"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.