{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "me",
  "description": "Getting information about the user that is making the request",
  "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."
    },
    "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 did provide a chargeable payment method."
        }
      },
      "required": ["plan_name", "plan_display_name", "chargeable"],
      "additionalProperties": false
    }
  },
  "required": ["id", "email", "customer_no", "subscription"],
  "additionalProperties": false
}
download