Users List Endpoints

Server

Endpoints for interacting with Users.

Users

GET

https://sandbox-api.vignette.id

/public/users

Returns an array of partner users who made at least 1 payment.

⚠️ Rate limit policy applies to this endpoint Check Rate Limits

Users › query Parameters

page

number

Page number for pagination. Default is 1.

Users › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Users › Responses

Users description test

get-all-user-schema

id

string

email

string

created_date

number

User Orders

GET

https://sandbox-api.vignette.id

/public/users/{id}/orders

An array of all vignettes for a specific user.

⚠️ Rate limit policy applies to this endpoint Check Rate Limits

User Orders › path Parameters

id

string · required

ID of user

User Orders › query Parameters

page

number

Page number for pagination. Default is 1.

User Orders › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

User Orders › Responses

Users - orders description test

get-user-orders-schema

id

string

custom_id

string

product

string

user_id

string

object[]

purchase_date

integer

start_from

integer

start_date

integer

end_date

integer

period

string

type

string

country

string

vehicle_type

string

Vehicle type of the order, e.g. car, van, moto.

status

string

OrderModifyCapability

Whether the order can be modified right now, and until when. Present only on orders bought with Flexible Service; on non-Flex orders reason_code is no_flex.

OrderRefundCapability

A refund tier. The full_refund and partial_refund tiers are mutually exclusive — at most one is eligible at a time; if neither, there is no refund. A pending tier still reports its terms (amount_eur, available_at) so you can show "€X now, or €Y after ".

OrderRefundCapability

OrderFlex

Flexible Service configuration recorded on the order. Present only when the order was bought with Flex.

receipt

string · uri

subaccount

string

GET/public/users/{id}/orders

curl https://sandbox-api.vignette.id/public/users/:id/orders \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "error": null,
  "pages": {
    "total": 1,
    "current": 1
  },
  "result": [
    {
      "id": "r24c1gqblg",
      "custom_id": "partner-custom-id",
      "product": "vignette-si-2a",
      "user_id": "y8efybzbk4",
      "cars": [
        {
          "plate": "AA2122AS",
          "country": "ua"
        }
      ],
      "purchase_date": 1756130793,
      "start_from": 1758232800,
      "start_date": 1758232800,
      "end_date": 1758837599,
      "period": "7",
      "type": "vignette",
      "country": "si",
      "status": "ACTIVE",
      "receipt": "https://vignette.id/invoices/pdf/199537_mxqu6g5b7v.pdf",
      "subaccount": "test_web"
    }
  ]
}

json

application/json

User Vehicles

GET

https://sandbox-api.vignette.id

/public/users/{id}/vehicles

An array of all vehicles for a specific user.

User Vehicles › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Products List Endpoints Orders List Endpoints