API v2.4 / Inventory / Refund bundle from inventory

Server

POST

/inventory/refund

eSIM Go API

Refunds an item in the inventory to the organisations balance. Takes a usageId and a quantity. The usageId’s can be found by querying the /inventory endpoint The quantity of a refund cannot exceed the remaining quantity left for the specific usageId. If you wish to refund multiple usageId’s, multiple calls to this endpoint will need to be done. If a bundle assignment has not been started and no data has been consumed, the bundle can be refunded as a credit back to the organisations balance. If the bundle assignment has started, or was purchased outside of their permitted refund period, typically 60 days, it cannot be refunded.

Request Body

object

{
  "usageId": 123456,
  "quantity": 1
}

Responses

200

object

status

Status message of api request

string

Example

{
  "status": "Successfully refunded bundles to balance"
}