Commerce
Update an agreement
AuthorizationBearer <token>
Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.
In: header
Path Parameters
id*string
UUIDv7 identifier of the resource.
Format
uuidHeader Parameters
Idempotency-Key?string
A unique key that makes this mutation safe to retry. Repeats replay the stored response; reuse with a different body returns 409 idempotency_conflict.
Length
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
All fields optional; only supplied fields are changed.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/agreements/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "agreement", "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811", "unit_id": "5becc822-b69e-4e66-a762-ad8e868dcab6", "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598", "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe", "number": "string", "status": "quote", "licence_fee_minor": 0, "currency": "str", "billing_interval": "week", "move_in_date": "2019-08-24", "move_out_date": "2019-08-24", "notice_given_at": "2019-08-24T14:15:22Z", "notice_period_days": 0, "terminated_at": "2019-08-24T14:15:22Z", "contract_id": "9aafc1a8-e497-46c9-ba0b-bd5b03c353e4", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }}{ "error": { "code": "unauthorized", "message": "Missing or invalid credential." }}{ "error": { "code": "insufficient_scope", "message": "The credential lacks a scope required by this endpoint." }}{ "error": { "code": "not_found", "message": "Resource not found." }}{ "error": { "code": "conflict", "message": "The request conflicts with current resource state." }}{ "error": { "code": "validation_error", "message": "One or more fields are invalid.", "details": [ { "field": "email", "issue": "must be a valid email address" } ] }}{ "error": { "code": "rate_limited", "message": "Rate limit exceeded. Retry after 7s." }}{ "error": { "code": "validation_error", "message": "string", "details": [ { "field": "string", "issue": "string" } ] }}