DEdealhub
Orders

Mark composite order as executed.

Marks the composite order as executed. This also executes the individual orders contained. Optionally, the execution time can be specified using the executedOn query parameter.

put/compositeOrders/{id}/execute

Request

  • Base URL
    https://api.app.subskribe.com
  • URL
    https://api.app.subskribe.com/compositeOrders/{id}/execute
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

Uniquely identifies the composite order.

Query parameters

executedOninteger

The date and time when the composite order was executed.

adminApprovalFlowBypassboolean

Bypass approval checks by admin

Response

successful operation

idstring
type'UPSELL_AND_EARLY_RENEWAL' | 'CANCEL_SINGLE_SUBSCRIPTION_AND_RESTRUCTURE'
isPrimaryCompositeOrderForCrmOpportunityboolean
entityIdstring
crmOpportunityIdstring
crmOpportunityNamestring
crmOpportunityStagestring
crmOpportunityTypestring
documentMasterTemplateIdstring uuid
createdOninteger
updatedOninteger
status'DRAFT' | 'SUBMITTED' | 'APPROVED' | 'EXECUTED' | 'EXPIRED'

Changes

No recorded changes to this operation across all 1 revision of this API.