v1

latestOpenAPI 3.0.22026-07-223907721.1 MB

Vouchers

Get a list of voucher charges

This call will give you a paginated list of voucher charges.

get/vouchers/{id}/charges

Path parameters

idstring required

Query parameters

pageinteger

per_pageinteger

filter[created_from]string RFC3339

Sets a filter to get all entries from this datetime - must be set in RFC3339 format, see https://tools.ietf.org/html/rfc3339

filter[created_to]string RFC3339

Sets a filter to get all entries up to this datetime - must be set in RFC3339 format, see https://tools.ietf.org/html/rfc3339

filter[order_number]string

Sets a filter to get all entries with a specific order number

filter[amount]string

Sets a filter to get all entries with a specific amount

Response

Example response

{
  "data": [
    {
      "id": "cff8784e5eb28b9b04860",
      "voucher_id": "cff8784e34b28b9b04860",
      "client_id": "cff8784e5eb28b81ca02a",
      "type": "charge",
      "amount": "10.53",
      "order_number": "ORDER-62642",
      "created_at": "2017-07-21T17:32:28+00:00",
      "updated_at": "2017-07-21T17:32:28+00:00"
    }
  ],
  "links": {
    "first": "http://domain/v1/vouchers?page=1",
    "last": "http://domain/v1/vouchers?page=5",
    "prev": "http://domain/v1/vouchers?page=3",
    "next": "http://domain/v1/vouchers?page=2"
  },
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "from": 1,
    "to": 15,
    "last_page": 167,
    "total": 2500,
    "path": "http://domain/v1/vouchers"
  }
}