Open an amendment on an executed BillingOrder; returns its lineage-stamped amendment quote

POST/v1/orders/{orderId}/amend

Authorization

AuthorizationBearer token · headerrequired

Public API key bearer token.

Path parameters

orderIdstringrequired

Query parameters

environmentstringrequired

merchantAccountIdstringrequired

Header parameters

Idempotency-Keystring

Required for production-safe retries on mutating routes. Reusing a key with a different request body returns 409.

min length 1

Request body

requiredapplication/json

linesBillingQuoteLineInput[]

Restatement lines for the amendment's first draft version. Omit to clone the target subscription's live items; an empty array signs an early termination.

Show properties

Array of BillingQuoteLineInput

priceIdstringrequired

quantityinteger

min 1

unitAmountinteger

Negotiated minor-unit amount. Overrides the catalog price when set.

min 0

descriptionstring

couponIdsstring[]

termsstring

metadataMetadata

Responses

200Success

dataobjectrequired

requestIdstringrequired

400Bad request, including malformed JSON

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

401Missing or invalid API key

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

409Conflict, including idempotency body drift

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

422Validation failed

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

429API key rate limit exceeded

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

defaultError

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

Request

curl -X POST "https://api.vortex.nyc/v1/orders/string/amend?environment=string&merchantAccountId=string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "lines": [
    {
      "priceId": "string",
      "quantity": 0,
      "unitAmount": 0,
      "description": "string"
    }
  ],
  "couponIds": [
    "string"
  ],
  "terms": "string",
  "metadata": {}
}'

const response = await fetch("https://api.vortex.nyc/v1/orders/string/amend?environment=string&merchantAccountId=string", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "lines": [
    {
      "priceId": "string",
      "quantity": 0,
      "unitAmount": 0,
      "description": "string"
    }
  ],
  "couponIds": [
    "string"
  ],
  "terms": "string",
  "metadata": {}
})
});

import requests

response = requests.post(
    "https://api.vortex.nyc/v1/orders/string/amend?environment=string&merchantAccountId=string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "lines": [
    {
      "priceId": "string",
      "quantity": 0,
      "unitAmount": 0,
      "description": "string"
    }
  ],
  "couponIds": [
    "string"
  ],
  "terms": "string",
  "metadata": {}
},
)

Response

{
  "data": {},
  "requestId": "string"
}