v1

latestOpenAPI 3.0.02026-07-24231140.6 KB
Orders

Retrieve user orders.

get/orders

Query parameters

startinteger

Start index (Default: 0).

limitinteger

Maximum amount of returned records (Maximum/Default: 50).

afterstring

Start date for limiting results (Inclusive).

beforestring

End date for limiting results (Non-Inclusive).

Response

Success

Example response

{
  "meta": {
    "limit": 1,
    "after": "2021-10-04 00:00:00",
    "before": "2021-10-05 00:00:00",
    "_endpoint": "/orders"
  },
  "data": [
    {
      "id": "615b35e2f616a8092ee45aff",
      "status": "created",
      "product": {
        "id": "test-gift-card-code",
        "name": "Test Gift Card Code",
        "value": "10",
        "currency": "USD",
        "image": "https://res.cloudinary.com/bitrefill/d_operator.png/this_is_a_test",
        "_href": "https://api-bitrefill.com/2/products/test-gift-card-code"
      },
      "created_time": "2021-10-04T17:12:02.101Z",
      "delivered_time": "2021-10-04T17:12:11.990Z",
      "redemption_info": "To redeem this gift card go to example.com and copy paste your PIN code",
      "commission": 0.0001,
      "gift_info": {
        "gift_id": "gift-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "gift_url": "https://www.bitrefill.com/gift/gift-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "recipient_name": "Jane Doe",
        "recipient_email": "jane@example.com",
        "sender_name": "John Doe",
        "message": "Happy birthday!",
        "send_date": "2025-12-25T09:00:00.000Z"
      },
      "user": {
        "id": "613b62204ef8b621bdb47539",
        "email": "test@bitrefill.com"
      },
      "invoice": {
        "id": "c2b27180-610e-4132-af77-ad42fc0ac444",
        "_href": "/invoices/c2b27180-610e-4132-af77-ad42fc0ac444"
      }
    }
  ]
}