Update order details

System-generated unique identifier for the order.

Unique external reference ID for the order that can be used for integration with other systems. This ID can't be reused on multiple orders.

Name or title of the order for easy identification.

Unique identifier of the account associated with this order.

Type of order being placed. This value determines how the order will impact a subscription when it is executed.

Supported values:

• NEW: Create a new subscription.
• CANCEL: Cancel an existing subscription.
• AMENDMENT: Amend an existing subscription.
• RENEWAL: Renew an existing subscription.
• RESTRUCTURE: Restructure an existing subscription.

Specifies when the payment for the invoice is due. Supported values are NET0, NET30, NET45, NET60, and NET90.

The ID of the subscription you want to amend, restructure, or cancel. To renew a subscription, use the renewalForSubscriptionId field to specify the ID of the subscription you want to renew. This field is not required while creating a new subscription.

ID of the contact to use for shipping information.

ID of the contact to use for billing information.

Start date of the subscription in Unix timestamp format (seconds since epoch). This date is inclusive.

End date of the subscription in Unix timestamp format (seconds since epoch). If not provided for TERMED subscriptions, it will be calculated based on termLength.

NOTE: This date is exclusive. For example, if the subscription's start date is 1735689600 (January 1, 2025 00:00:00) and the term length is 1 year, specify the end date as 1767225600 (January 1, 2026 00:00:00). Since the date is exclusive, the subscription is still active at December 31, 2025 23:59:59 but will have ended at January 1, 2026 00:00:00.

Date when the order was executed in Unix timestamp format. Don't include this field if you're creating an order with orderType = NEW. This field is required only when you're creating an order to amend, renew, restructure, or cancel an existing subscription.

Specifies when billing occurs relative to service delivery.

Supported values:

• UP_FRONT: Billing occurs before the product or service is delivered
• IN_ARREARS: The customer is billed after receiving the product or service.

Specific date to anchor billing cycles to, in Unix timestamp format (seconds since epoch). Useful for aligning billing with specific dates (e.g., first of the month).

Type of CRM where the opportunity is managed.

ID of the user who owns this order.

ID of the subscription being renewed. Required only when orderType is RENEWAL.

UUID of the master document template to use for generating order documents.

The purchase order number associated with this order.

Indicates whether a purchase order number is required to generate an invoice.

Indicates whether the subscription should automatically renew at the end of its term.

ID of the approval segment to use for routing this order through approval workflows.

ID of an attachment associated with this order (e.g., signed contract).

Date when the order expires if the status is not EXECUTED. Specified in Unix timestamp format (seconds since epoch).

ID of the entity (e.g., business or subsidiary) associated with this order.

Determines how the start date is calculated.

NOTE: If you include the rampInterval object dates for a ramped pricing schedule, startDateType must be set to FIXED.

Supported values:

• FIXED: Start date is the value of startDate, or the first rampInterval timestamp if specified.
• EXECUTION_DATE: Start date is the date when the order status changes to EXECUTED.

ISO 4217 currency code for the order. If you don't specify a value, the account's default currency is used.

Determines the subscription term.

Supported values:

• TERMED: Subscription has a fixed term length.
• EVERGREEN: Subscription continues indefinitely until cancelled.