Cancel an Order: /orders/{order_id}/cancel
Purpose
This endpoint cancels an existing order by marking its status as INACTIVE. The cancellation can take effect immediately or be scheduled for a future date based on the effective_date provided in the request.
Use Case
This endpoint is used when a customer or admin wants to stop an active recurring order. The function accepts an effective_date to control when the cancellation takes place. If the date is today , the order is immediately inactivated. If it is in the future, the order remains active until the scheduled cancellation date, allowing billing or service to continue for the current cycle.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| order_id | String | Unique identifier of the order. |
Query Parameters
No query parameters required for this endpoint.
Request Body
The request body includes the date when the cancellation should become effective. This allows support for both immediate and scheduled cancellations.
{
"order": {
"effective_date": "EFFECTIVE_DATE"
}
}| Attribute | Type | Description |
|---|---|---|
| order.effective_date | String | The date (YYYY-MM-DD) when the cancellation applies. |
Response
The API response confirms that the order has been successfully cancelled. It returns the updated order object, where the status is set to "INACTIVE", and includes associated metadata such as event_uuid, timestamps, item details, and all billing and fulfillment settings at the time of cancellation. Each line item is preserved with pricing, discount, and tax information to maintain a record of what was included in the order before it was cancelled. This comprehensive response ensures transparency and supports historical tracking of cancelled orders.
{
"event_uuid": "EVENT_UUID",
"order": {
"status": "ORDER_STATUS",
"id": "ORDER_ID",
"pre_order": "BOOLEAN",
"quote_order": "BOOLEAN",
"name": "ORDER_NAME",
"display_name": "ORDER_DISPLAY_NAME",
"description": "ORDER_DESCRIPTION",
"referral_account": "EMPTY",
"customer_purchase_order_id": "CUSTOMER_PO_ID",
"shipping_profile": {},
"shipping_cost": "DECIMAL_VALUE",
"discount_profile": null,
"origin": "ORDER_ORIGIN",
"custom_forms": {
"uuid": "CUSTOM_FORM_UUID",
"name": "CUSTOM_FORM_NAME"
},
"currency": {
"uuid": "CURRENCY_UUID",
"name": "CURRENCY_CODE",
"link": "CURRENCY_API_LINK"
},
"time_zone": {
"uuid": "TIMEZONE_UUID",
"name": "TIMEZONE_NAME",
"link": "TIMEZONE_API_LINK"
},
"invoice_note": "INVOICE_NOTE",
"communication_preference": [
{
"media": "COMMUNICATION_MEDIA",
"isEnabled": "BOOLEAN"
}
],
"billing_start_date": "BILLING_START_DATE",
"order_start_date": "ORDER_START_TIMESTAMP",
"next_billing_from_date": "EMPTY",
"price_tax_inclusive": "BOOLEAN",
"billing_address": {},
"shipping_address": {},
"created_by": "CREATED_BY",
"created_on": "CREATION_TIMESTAMP",
"last_updated_by": "UPDATED_BY",
"last_updated_on": "UPDATE_TIMESTAMP",
"uuid": "ORDER_UUID",
"version": "VERSION",
"account_id": "ACCOUNT_ID",
"account_name": "ACCOUNT_NAME",
"allow_contract": "BOOLEAN",
"custom_attributes": [],
"custom_objects": [],
"currency_id": "CURRENCY_ID",
"properties": {
"communication_profile": "COMMUNICATION_PROFILE",
"invoice_mode": "INVOICE_MODE",
"invoice_term": "INVOICE_TERM",
"billing_period": "BILLING_PERIOD",
"consolidate_invoice": "BOOLEAN",
"consolidate_key": "CONSOLIDATION_KEY",
"payment_processor": "PAYMENT_PROCESSOR",
"payment_mode": "PAYMENT_MODE",
"payment_term": "PAYMENT_TERM",
"payment_term_alignment": "PAYMENT_TERM_ALIGNMENT",
"fulfillment_mode": "FULFILLMENT_MODE",
"fulfillment_term": "FULFILLMENT_TERM"
},
"lines": [
{
"charge_item_uuid": "CHARGE_ITEM_UUID",
"item_uuid": "ITEM_UUID",
"item_id": "ITEM_ID",
"item_name": "ITEM_NAME",
"item_order_quantity": "DECIMAL_VALUE",
"shipping_cost": "DECIMAL_VALUE",
"item_invoice_note": "EMPTY",
"item_description": "EMPTY",
"item_type": "ITEM_TYPE",
"item_charge_type": "CHARGE_TYPE",
"item_custom_attributes": [],
"item_properties": {
"billing_mode": "BILLING_MODE",
"charging_period": "CHARGING_PERIOD",
"charging_start_date": "CHARGING_START_DATE",
"fixed_start_date": "EMPTY",
"charging_and_billing_alignment": "BOOLEAN",
"pro_rata_partial_charging_period": "BOOLEAN",
"pro_rata_partial_pricing_period": "BOOLEAN",
"pro_rata_partial_unit": "BOOLEAN"
},
"item_price_snapshot": {
"pricing_rule": {
"uuid": "PRICING_RULE_UUID",
"version": "VERSION",
"price_type": "PRICE_TYPE",
"price": "DECIMAL_VALUE",
"uom": "EMPTY",
"price_period": "EMPTY",
"pricing_schedule": "EMPTY",
"pricing_level": "EMPTY",
"pricing_method": "DECIMAL_VALUE",
"warehouse": "WAREHOUSE_NAME"
}
},
"item_sale_tax_configuration": {
"sale_price_is_based_on": "TAX_BASIS",
"tax_code": {
"uuid": "EMPTY",
"code": "EMPTY",
"rate": "EMPTY",
"link": "EMPTY"
}
},
"isTaxExemptWhenSold": "BOOLEAN",
"item_price_tax": {
"uuid": "EMPTY",
"code": "EMPTY",
"rate": "DECIMAL_VALUE",
"link": "EMPTY"
},
"item_accounting_code": {
"sales_revenue": "EMPTY"
},
"version": "VERSION",
"expected_delivery_date": "EMPTY",
"discount": "DECIMAL_VALUE",
"total": "DECIMAL_VALUE",
"subtotal": "DECIMAL_VALUE",
"tax": "DECIMAL_VALUE"
}
],
"total": "DECIMAL_VALUE",
"subtotal": "DECIMAL_VALUE",
"tax": "DECIMAL_VALUE",
"kpis": {
"start_date": "EMPTY",
"estimated_total": "DECIMAL_VALUE",
"total_revenue": "DECIMAL_VALUE",
"monthly_recurring_revenue": "DECIMAL_VALUE",
"total_collected": "DECIMAL_VALUE",
"total_outstanding": "DECIMAL_VALUE",
"total_due": "DECIMAL_VALUE",
"last_invoice_issue_date": "EMPTY",
"last_invoice_total": "DECIMAL_VALUE",
"total_invoice": "DECIMAL_VALUE",
"next_invoice_issueDate": "EMPTY",
"last_reactivated_on": "EMPTY",
"last_cancelled_on": "EMPTY",
"last_changed_on": "EMPTY",
"last_deleted_on": "EMPTY"
},
"line_items": []
}
}| Attribute | Type | Description |
|---|---|---|
| event_uuid | String | Unique identifier associated with the cancellation event. |
| order.status | String | Updated status of the order, set to "INACTIVE" after cancellation. |
| order.id | String | Unique identifier of the cancelled order. |
| order.name | String | Name or label of the order. |
| order.description | String | Description of the order content. |
| order.currency.name | String | Currency used for the order ("AUD"). |
| order.time_zone.name | String | Time zone configured for the order . |
| order.communication_preference | Array | List of communication methods enabled for the order . |
| order.created_by | String | Name of the user who created the order. |
| order.created_on | String | Timestamp of when the order was originally created. |
| order.last_updated_by | String | Name of the user who last modified the order. |
| order.last_updated_on | String | Timestamp of the most recent update to the order. |
| order.lines | Array | List of items in the order with pricing, quantity, and tax configurations. |
| order.total | String | Final total price of the order after applying discounts. |
| order.tax | String | Total tax amount applied to the order. |
| order.subtotal | String | Total amount before tax and discount. |
| order.properties | Object | Configuration of billing, payment, and fulfillment policies. |
| order.kpis | Object | Key performance indicators related to revenue, invoices, and collection. |
Reactivate an Order : /orders/{order_id}/reactivate
Purpose
This endpoint reactivate an order that was previously marked as inactive or cancelled. It updates the order’s status based on a provided effective date and schedules reactivation accordingly.
Use Case
The endpoint is used when a previously cancelled order needs to be reinstated. If the effective_date is the current date, the system will reactivate the order immediately. If the date is set in the future, the order remains in a pending state until that date arrives. This is especially useful for subscription or billing systems that allow temporary suspension of services with a scheduled reactivation.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| order_id | String | Unique identifier of the order. |
Query Parameters
No query parameters required for this endpoint.
Request Body
The request body includes the effective_date, which specifies when the order should become active again.
{
"account": {
"effective_date": "EFFECTIVE_DATE"
}
}| Attribute | Type | Description |
|---|---|---|
| order.effective_date | String | The date (YYYY-MM-DD) to reactivate the order. |
Response
The endpoint return a successful reactivation request object containing an event_uuid that uniquely identifies the reactivation event. This UUID can be used for tracking or audit purposes.
{
"event_uuid": "EVENT_UUID"
}| Attribute | Type | Description |
|---|---|---|
| event_uuid | String | UUID representing the order reactivation event. |
Create Order Note: /orders/{order_id}/notes
Purpose
This endpoint creates a new note for a specific order. It supports both plain text notes and file attachments, making it useful for order-related documentation, attaching receipts, scanned documents, or additional remarks.
Use Case
- Add internal or customer-facing notes to an order.
- Attach supporting files (e.g., images, invoices, receipts) directly to an order.
- Maintain a timeline of comments and attachments for order tracking.
- Provide documentation for audits, compliance, or customer communication.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| order_id | string | Yes | Unique identifier of the order to which the note will be added. |
Query Parameters
This endpoint does not support query parameters.
Request Body
The request must be sent as multipart/form-data.
| Attribute | Type | Description |
|---|---|---|
| note | string | Content of the note. |
| file | file | File to attach with the note. Accepts common document and image formats. |
Response
On success, the API returns the order object containing a notes object with the UUID of the newly created note. This UUID can later be used to fetch note details, list attached files, or download specific files.
Response Body
{
"order": {
"notes": {
"uuid": "UUID"
}
}
}| Attribute | Type | Description |
|---|---|---|
| order | object | Container object holding the response data. |
| order.notes | object | Object representing the newly created note. |
| order.notes.uuid | string (UUID) | Unique identifier of the created note. |