Orders

Fetch composite order

Fetches the composite order with the specified id.

get/compositeOrders/{id}

Request

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

Path parameters

idstring required

id of the composite order

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.