Services

Endpoints related to the active services used by a hub.

List Billing Services

Requries the billing-services-view 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`

Responses

200

Returns a list of Billing Services.

default

General error response from the platform

get/v1/billing/services

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"title": "string",
"order": {"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": null,
"name": null,
"price": null
},
"tier": {"id": null,
"name": null,
"price": null
}
},
"description": "string",
"price": {"mills": 0,
"term": "once"
},
"discount": {"id": "string",
"amount": {"mills": null,
"term": null
},
"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"
}
}
},
"item": {"support": {"id": "651586fca6078e98982dbd90",
"name": "string",
"price": 0
},
"tier": {"id": "651586fca6078e98982dbd90",
"name": "string",
"price": {"mills": 0,
"term": "once"
}
}
},
"discount": {"id": "651586fca6078e98982dbd90",
"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
},
"price": {"mills": 0,
"term": "once"
},
"term": {"start": "2021-01-30T08:30:00Z",
"end": "2021-01-30T08:30:00Z",
"renew": "once"
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_billed": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
]
}

Get Billing Service

Requries the billing-services-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

servicesId

required

string

The ID of the Billing Service.

Responses

200

Returns the Hub's specified Billing Service.

default

General error response from the platform

get/v1/billing/services/{servicesId}

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"title": "string",
"order": {"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"
}
}
},
"item": {"support": {"id": "651586fca6078e98982dbd90",
"name": "string",
"price": 0
},
"tier": {"id": "651586fca6078e98982dbd90",
"name": "string",
"price": {"mills": 0,
"term": "once"
}
}
},
"discount": {"id": "651586fca6078e98982dbd90",
"amount": {"mills": 0,
"term": "once"
},
"expires": "2021-01-30T08:30:00Z"
},
"price": {"mills": 0,
"term": "once"
},
"term": {"start": "2021-01-30T08:30:00Z",
"end": "2021-01-30T08:30:00Z",
"renew": "once"
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_billed": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
}

List Billing Overages

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`

Responses

200

Returns Billing Overages.

default

General error response from the platform

get/v1/billing/services/overages

Response samples

200
default

application/json

{"data": [{"term": {"start": "2021-01-30T08:30:00Z",
"end": "2021-01-30T08:30:00Z",
"renew": "once"
},
"ram": {"gb_hours": 0,
"cost": 0
}
}
]
}

➔ Next to Containers