current_user

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/shipcloud/main/json-schema/shipcloud-current-user-schema.json",
  "title": "current_user",
  "description": "Getting information about the user that is making the request",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/shipcloud-openapi.yml#/components/schemas/current_user",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this user (generated by shipcloud)."
    },
    "email": {
      "type": "string",
      "description": "The email address associated with this user"
    },
    "first_name": {
      "type": "string",
      "description": "First name of the user."
    },
    "last_name": {
      "type": "string",
      "description": "Last name of the user."
    },
    "customer_no": {
      "type": "string",
      "description": "The unique identifier for this customer (generated by shipcloud). Used e.g. in support cases."
    },
    "environment": {
      "type": "string",
      "description": "Shows the corresponding environment for the currently used api key.",
      "enum": [
        "production",
        "sandbox"
      ]
    },
    "subscription": {
      "type": "object",
      "properties": {
        "plan_name": {
          "type": "string",
          "description": "A key to identify the plan the user currently has"
        },
        "plan_display_name": {
          "type": "string",
          "description": "Name of the plan the user currently has. Can be used for displaying it at the frontend."
        },
        "chargeable": {
          "type": "boolean",
          "description": "true if the user has provided a chargeable payment method."
        }
      },
      "required": [
        "plan_name",
        "plan_display_name",
        "chargeable"
      ]
    }
  },
  "required": [
    "id",
    "email",
    "customer_no",
    "environment",
    "subscription"
  ]
}