Orders

Endpoints related to orders placed on a hub.

List Billing Orders

Requires the billing-services-manage capability.

SecuritybearerAuth and hubAuth

Request

query Parameters

sort	Array of strings An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
filter	object
	object In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`
meta	Array of strings Items Value: "due"
include	Array of strings Items Value: "promo_codes"

Responses

200

Returns a list of Billing Orders.

default

General error response from the platform

get/v1/billing/orders

Response samples

200
default

application/json

{"data": [{"hub_id": "string",
"creator": {"type": "account",
"id": "651586fca6078e98982dbd90"
},
"promo_code_id": "string",
"term": {"start": "2021-01-30T08:30:00Z",
"end": "2021-01-30T08:30:00Z",
"renew": "once"
},
"approved": true,
"items": [{"id": "string",
"service": {"support": {"id": "651586fca6078e98982dbd90",
"name": "string",
"price": 0
},
"tier": {"id": "651586fca6078e98982dbd90",
"name": "string",
"price": {"mills": null,
"term": null
}
}
},
"description": "string",
"price": {"mills": 0,
"term": "once"
},
"discount": {"id": "string",
"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
},
"net_price": 0
}
],
"total_price": 0,
"events": {"expires": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
],
"includes": {"promo_codes": {"property1": {"code": "string",
"credit": {"property1": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
},
"property2": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
},
"property2": {"code": "string",
"credit": {"property1": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
},
"property2": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
}
}
}

Create Billing Order

Requires the billing-orders-manage capability.

SecuritybearerAuth and hubAuth

Request

query Parameters

meta	Array of strings Items Value: "due"
include	Array of strings Items Value: "promo_codes"

Request Body schema: application/json

Parameters for creating a new order

tier_plan_id	string ID associated with the tier plan
support_plan_id	string ID associated with the support plan
term_length	string String that defines term length Enum: "once" "monthly" "yearly"
promo_code	string String that defines a promo code

Responses

201

Returns a Billing Order.

default

General error response from the platform

post/v1/billing/orders

Request samples

Payload

application/json

{"tier_plan_id": "string",
"support_plan_id": "string",
"term_length": "once",
"promo_code": "string"
}

Response samples

201
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"promo_code_id": "string",
"term": {"start": "2021-01-30T08:30:00Z",
"end": "2021-01-30T08:30:00Z",
"renew": "once"
},
"approved": true,
"items": [{"support": {"id": "651586fca6078e98982dbd90",
"name": "string",
"price": 0
},
"tier": {"id": "651586fca6078e98982dbd90",
"name": "string",
"price": {"mills": 0,
"term": "once"
}
}
}
],
"total_price": 0,
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"expires": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
},
"includes": {"promo_codes": {"property1": {"code": "string",
"credit": {"property1": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
},
"property2": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
},
"property2": {"code": "string",
"credit": {"property1": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
},
"property2": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
}
}
}

Get Billing Order

Requires the billing-services-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

orderId

required

string

The ID of the billing order.

query Parameters

meta	Array of strings Items Value: "due"
include	Array of strings Items Value: "promo_codes"

Responses

200

Returns a Billing Order

default

General error response from the platform

get/v1/billing/orders/{orderId}

Response samples

200
default

application/json

{"data": {"hub_id": "string",
"creator": {"type": "account",
"id": "651586fca6078e98982dbd90"
},
"promo_code_id": "string",
"term": {"start": "2021-01-30T08:30:00Z",
"end": "2021-01-30T08:30:00Z",
"renew": "once"
},
"approved": true,
"items": [{"id": "string",
"service": {"support": {"id": "651586fca6078e98982dbd90",
"name": "string",
"price": 0
},
"tier": {"id": "651586fca6078e98982dbd90",
"name": "string",
"price": {"mills": 0,
"term": "once"
}
}
},
"description": "string",
"price": {"mills": 0,
"term": "once"
},
"discount": {"id": "string",
"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
},
"net_price": 0
}
],
"total_price": 0,
"events": {"expires": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
},
"includes": {"promo_codes": {"property1": {"code": "string",
"credit": {"property1": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
},
"property2": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
},
"property2": {"code": "string",
"credit": {"property1": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
},
"property2": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
}
}
}

Update Billing Order

Requires the billing-services-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

orderId

required

string

The ID of the billing order.

query Parameters

meta	Array of strings Items Value: "due"
include	Array of strings Items Value: "promo_codes"

Request Body schema: application/json

tier_plan_id	string ID associated with the tier plan
support_plan_id	string ID associated with the support plan
term_length	string String that defines term length Enum: "once" "monthly" "yearly"
promo_code	string String that defines a promo code

Responses

200

Returns a Billing Order.

default

General error response from the platform

patch/v1/billing/orders/{orderId}

Request samples

Payload

application/json

{"tier_plan_id": "string",
"support_plan_id": "string",
"term_length": "once",
"promo_code": "string"
}

Response samples

200
default

application/json

{"data": {"hub_id": "string",
"creator": {"type": "account",
"id": "651586fca6078e98982dbd90"
},
"promo_code_id": "string",
"term": {"start": "2021-01-30T08:30:00Z",
"end": "2021-01-30T08:30:00Z",
"renew": "once"
},
"approved": true,
"items": [{"id": "string",
"service": {"support": {"id": "651586fca6078e98982dbd90",
"name": "string",
"price": 0
},
"tier": {"id": "651586fca6078e98982dbd90",
"name": "string",
"price": {"mills": 0,
"term": "once"
}
}
},
"description": "string",
"price": {"mills": 0,
"term": "once"
},
"discount": {"id": "string",
"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
},
"net_price": 0
}
],
"total_price": 0,
"events": {"expires": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
},
"includes": {"promo_codes": {"property1": {"code": "string",
"credit": {"property1": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
},
"property2": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
},
"property2": {"code": "string",
"credit": {"property1": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
},
"property2": {"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
}
}
}

Create Billing Order Job

Used to confirm a Billing Order.

Requires the billing-services-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

orderId

required

string

The ID of the requested Order

Request Body schema: application/json

action

required

string

The name of the action to perform

Value: "confirm"

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/billing/orders/{orderId}/tasks

Request samples

Payload

application/json

{"action": "confirm"
}

Response samples

202
default

application/json

{"data": {"action": "string",
"job": {"id": "string",
"accepted": true,
"queue": "string",
"schedule": "2021-01-30T08:30:00Z",
"parallel": {"sub_queue": "string",
"tasks": true
},
"tasks": [{"caption": "string",
"header": "string",
"steps": [{"caption": "string",
"description": "string",
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
],
"input": {"property1": null,
"property2": null
}
}
]
}
}
}

➔ Next to Plans